From 283e0987c664faffe60473e3f62aa7659751fd31 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:38 +0000 Subject: [PATCH 1/7] feat(aiplatform)!: update the API BREAKING CHANGE: This release has breaking changes. #### aiplatform:v1beta1 The following keys were deleted: - resources.interactions.methods.delete.description - resources.interactions.methods.delete.flatPath - resources.interactions.methods.delete.httpMethod - resources.interactions.methods.delete.id - resources.interactions.methods.delete.parameterOrder - resources.interactions.methods.delete.parameters.name.description - resources.interactions.methods.delete.parameters.name.location - resources.interactions.methods.delete.parameters.name.pattern - resources.interactions.methods.delete.parameters.name.required - resources.interactions.methods.delete.parameters.name.type - resources.interactions.methods.delete.path - resources.interactions.methods.delete.response.$ref - resources.interactions.methods.delete.scopes - resources.interactions.methods.getPoll.parameters.include_input.deprecated - resources.interactions.methods.getPoll.parameters.include_input.description - resources.interactions.methods.getPoll.parameters.include_input.location - resources.interactions.methods.getPoll.parameters.include_input.type - resources.interactions.methods.getPoll.parameters.last_event_id.description - resources.interactions.methods.getPoll.parameters.last_event_id.location - resources.interactions.methods.getPoll.parameters.last_event_id.type - resources.interactions.methods.getStream.parameters.include_input.deprecated - resources.interactions.methods.getStream.parameters.include_input.description - resources.interactions.methods.getStream.parameters.include_input.location - resources.interactions.methods.getStream.parameters.include_input.type - resources.interactions.methods.getStream.parameters.last_event_id.description - resources.interactions.methods.getStream.parameters.last_event_id.location - resources.interactions.methods.getStream.parameters.last_event_id.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.scopes - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.flatPath - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.httpMethod - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.id - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameterOrder - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.pattern - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.required - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.parameters.name.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.path - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.response.$ref - resources.semanticGovernancePolicyEngine.resources.operations.methods.cancel.scopes - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.flatPath - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.httpMethod - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.id - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameterOrder - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.pattern - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.required - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.parameters.name.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.path - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.response.$ref - resources.semanticGovernancePolicyEngine.resources.operations.methods.delete.scopes - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.flatPath - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.httpMethod - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.id - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameterOrder - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.pattern - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.required - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.parameters.name.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.path - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.response.$ref - resources.semanticGovernancePolicyEngine.resources.operations.methods.get.scopes - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.flatPath - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.httpMethod - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.id - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameterOrder - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.filter.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.pattern - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.required - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.name.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.format - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageSize.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.pageToken.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.path - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.response.$ref - resources.semanticGovernancePolicyEngine.resources.operations.methods.list.scopes - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.flatPath - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.httpMethod - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.id - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameterOrder - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.pattern - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.required - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.name.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.description - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.format - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.location - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.parameters.timeout.type - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.path - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.response.$ref - resources.semanticGovernancePolicyEngine.resources.operations.methods.wait.scopes - schemas.GenaiField.description - schemas.GenaiField.id - schemas.GenaiField.properties.name.type - schemas.GenaiField.properties.value.$ref - schemas.GenaiField.type - schemas.GenaiListValue.description - schemas.GenaiListValue.id - schemas.GenaiListValue.properties.values.description - schemas.GenaiListValue.properties.values.items.$ref - schemas.GenaiListValue.properties.values.type - schemas.GenaiListValue.type - schemas.GenaiStruct.description - schemas.GenaiStruct.id - schemas.GenaiStruct.properties.fields.description - schemas.GenaiStruct.properties.fields.items.$ref - schemas.GenaiStruct.properties.fields.type - schemas.GenaiStruct.type - schemas.GenaiValue.description - schemas.GenaiValue.id - schemas.GenaiValue.properties.boolValue.description - schemas.GenaiValue.properties.boolValue.type - schemas.GenaiValue.properties.listValue.$ref - schemas.GenaiValue.properties.listValue.description - schemas.GenaiValue.properties.nullValue.description - schemas.GenaiValue.properties.nullValue.enum - schemas.GenaiValue.properties.nullValue.enumDescriptions - schemas.GenaiValue.properties.nullValue.type - schemas.GenaiValue.properties.numberValue.description - schemas.GenaiValue.properties.numberValue.format - schemas.GenaiValue.properties.numberValue.type - schemas.GenaiValue.properties.stringValue.description - schemas.GenaiValue.properties.stringValue.type - schemas.GenaiValue.properties.structValue.$ref - schemas.GenaiValue.properties.structValue.description - schemas.GenaiValue.type - schemas.GenaiVertexV1beta1AgentInteraction.properties.deep_research_config.$ref - schemas.GenaiVertexV1beta1AgentInteraction.properties.dynamic_config.$ref - schemas.GenaiVertexV1beta1ArgumentsDelta.properties.partial_arguments.type - schemas.GenaiVertexV1beta1AudioContent.properties.mime_type.description - schemas.GenaiVertexV1beta1AudioContent.properties.mime_type.enum - schemas.GenaiVertexV1beta1AudioContent.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1AudioContent.properties.mime_type.type - schemas.GenaiVertexV1beta1AudioContent.properties.sample_rate.description - schemas.GenaiVertexV1beta1AudioContent.properties.sample_rate.format - schemas.GenaiVertexV1beta1AudioContent.properties.sample_rate.type - schemas.GenaiVertexV1beta1AudioDelta.properties.mime_type.enum - schemas.GenaiVertexV1beta1AudioDelta.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1AudioDelta.properties.mime_type.type - schemas.GenaiVertexV1beta1AudioDelta.properties.sample_rate.description - schemas.GenaiVertexV1beta1AudioDelta.properties.sample_rate.format - schemas.GenaiVertexV1beta1AudioDelta.properties.sample_rate.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bit_rate.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bit_rate.format - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bit_rate.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mime_type.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mime_type.enum - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mime_type.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sample_rate.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sample_rate.format - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sample_rate.type - schemas.GenaiVertexV1beta1CodeExecutionResultContent.properties.is_error.description - schemas.GenaiVertexV1beta1CodeExecutionResultContent.properties.is_error.type - schemas.GenaiVertexV1beta1CodeExecutionResultDelta.properties.is_error.type - schemas.GenaiVertexV1beta1CodeExecutionResultStep.properties.is_error.description - schemas.GenaiVertexV1beta1CodeExecutionResultStep.properties.is_error.type - schemas.GenaiVertexV1beta1ComputerUse.properties.excluded_predefined_functions.description - schemas.GenaiVertexV1beta1ComputerUse.properties.excluded_predefined_functions.items.type - schemas.GenaiVertexV1beta1ComputerUse.properties.excluded_predefined_functions.type - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.collaborative_planning.description - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.collaborative_planning.type - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinking_summaries.description - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinking_summaries.enum - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinking_summaries.enumDescriptions - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinking_summaries.type - schemas.GenaiVertexV1beta1DocumentContent.properties.mime_type.description - schemas.GenaiVertexV1beta1DocumentContent.properties.mime_type.enum - schemas.GenaiVertexV1beta1DocumentContent.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1DocumentContent.properties.mime_type.type - schemas.GenaiVertexV1beta1DocumentDelta.properties.mime_type.enum - schemas.GenaiVertexV1beta1DocumentDelta.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1DocumentDelta.properties.mime_type.type - schemas.GenaiVertexV1beta1FileCitation.properties.custom_metadata.$ref - schemas.GenaiVertexV1beta1FileCitation.properties.custom_metadata.description - schemas.GenaiVertexV1beta1FileCitation.properties.document_uri.description - schemas.GenaiVertexV1beta1FileCitation.properties.document_uri.type - schemas.GenaiVertexV1beta1FileCitation.properties.file_name.description - schemas.GenaiVertexV1beta1FileCitation.properties.file_name.type - schemas.GenaiVertexV1beta1FileCitation.properties.media_id.description - schemas.GenaiVertexV1beta1FileCitation.properties.media_id.type - schemas.GenaiVertexV1beta1FileCitation.properties.page_number.description - schemas.GenaiVertexV1beta1FileCitation.properties.page_number.format - schemas.GenaiVertexV1beta1FileCitation.properties.page_number.type - schemas.GenaiVertexV1beta1FileSearch.properties.file_search_store_names.description - schemas.GenaiVertexV1beta1FileSearch.properties.file_search_store_names.items.type - schemas.GenaiVertexV1beta1FileSearch.properties.file_search_store_names.type - schemas.GenaiVertexV1beta1FileSearch.properties.metadata_filter.description - schemas.GenaiVertexV1beta1FileSearch.properties.metadata_filter.type - schemas.GenaiVertexV1beta1FileSearch.properties.top_k.description - schemas.GenaiVertexV1beta1FileSearch.properties.top_k.format - schemas.GenaiVertexV1beta1FileSearch.properties.top_k.type - schemas.GenaiVertexV1beta1FunctionResultContent.properties.is_error.description - schemas.GenaiVertexV1beta1FunctionResultContent.properties.is_error.type - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.contentList.$ref - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.is_error.type - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.stringResult.type - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.structResult.$ref - schemas.GenaiVertexV1beta1FunctionResultStep.properties.contentList.$ref - schemas.GenaiVertexV1beta1FunctionResultStep.properties.is_error.description - schemas.GenaiVertexV1beta1FunctionResultStep.properties.is_error.type - schemas.GenaiVertexV1beta1FunctionResultStep.properties.stringResult.type - schemas.GenaiVertexV1beta1FunctionResultStep.properties.structResult.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.image_config.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.image_config.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.max_output_tokens.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.max_output_tokens.format - schemas.GenaiVertexV1beta1GenerationConfig.properties.max_output_tokens.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.speech_config.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.speech_config.items.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.speech_config.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.stop_sequences.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.stop_sequences.items.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.stop_sequences.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_level.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_level.enum - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_level.enumDescriptions - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_level.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_summaries.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_summaries.enum - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_summaries.enumDescriptions - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinking_summaries.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.top_p.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.top_p.format - schemas.GenaiVertexV1beta1GenerationConfig.properties.top_p.type - schemas.GenaiVertexV1beta1GoogleMaps.properties.enable_widget.description - schemas.GenaiVertexV1beta1GoogleMaps.properties.enable_widget.type - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult.properties.widget_context_token.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult.properties.widget_context_token.type - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.place_id.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.place_id.type - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.review_snippets.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.review_snippets.items.$ref - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.review_snippets.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem.properties.widget_context_token.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.place_id.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.review_snippets.items.$ref - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.review_snippets.type - schemas.GenaiVertexV1beta1GoogleSearch.properties.search_types.description - schemas.GenaiVertexV1beta1GoogleSearch.properties.search_types.items.enum - schemas.GenaiVertexV1beta1GoogleSearch.properties.search_types.items.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearch.properties.search_types.items.type - schemas.GenaiVertexV1beta1GoogleSearch.properties.search_types.type - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.search_type.description - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.search_type.enum - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.search_type.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.search_type.type - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.search_type.description - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.search_type.enum - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.search_type.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.search_type.type - schemas.GenaiVertexV1beta1GoogleSearchResultContent.properties.is_error.description - schemas.GenaiVertexV1beta1GoogleSearchResultContent.properties.is_error.type - schemas.GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult.properties.search_suggestions.description - schemas.GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult.properties.search_suggestions.type - schemas.GenaiVertexV1beta1GoogleSearchResultDelta.properties.is_error.type - schemas.GenaiVertexV1beta1GoogleSearchResultStep.properties.is_error.description - schemas.GenaiVertexV1beta1GoogleSearchResultStep.properties.is_error.type - schemas.GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem.properties.search_suggestions.description - schemas.GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem.properties.search_suggestions.type - schemas.GenaiVertexV1beta1ImageConfig.properties.aspect_ratio.description - schemas.GenaiVertexV1beta1ImageConfig.properties.aspect_ratio.type - schemas.GenaiVertexV1beta1ImageConfig.properties.image_size.description - schemas.GenaiVertexV1beta1ImageConfig.properties.image_size.type - schemas.GenaiVertexV1beta1ImageContent.properties.mime_type.description - schemas.GenaiVertexV1beta1ImageContent.properties.mime_type.enum - schemas.GenaiVertexV1beta1ImageContent.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1ImageContent.properties.mime_type.type - schemas.GenaiVertexV1beta1ImageDelta.properties.mime_type.enum - schemas.GenaiVertexV1beta1ImageDelta.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1ImageDelta.properties.mime_type.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspect_ratio.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspect_ratio.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspect_ratio.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspect_ratio.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.image_size.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.image_size.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.image_size.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.image_size.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mime_type.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mime_type.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mime_type.type - schemas.GenaiVertexV1beta1Interaction.properties.previous_interaction_id.description - schemas.GenaiVertexV1beta1Interaction.properties.previous_interaction_id.type - schemas.GenaiVertexV1beta1Interaction.properties.response_format.$ref - schemas.GenaiVertexV1beta1Interaction.properties.response_format.deprecated - schemas.GenaiVertexV1beta1Interaction.properties.response_format.description - schemas.GenaiVertexV1beta1Interaction.properties.response_mime_type.description - schemas.GenaiVertexV1beta1Interaction.properties.response_mime_type.type - schemas.GenaiVertexV1beta1Interaction.properties.response_modalities.description - schemas.GenaiVertexV1beta1Interaction.properties.response_modalities.items.enum - schemas.GenaiVertexV1beta1Interaction.properties.response_modalities.items.enumDescriptions - schemas.GenaiVertexV1beta1Interaction.properties.response_modalities.items.type - schemas.GenaiVertexV1beta1Interaction.properties.response_modalities.type - schemas.GenaiVertexV1beta1Interaction.properties.system_instruction.description - schemas.GenaiVertexV1beta1Interaction.properties.system_instruction.type - schemas.GenaiVertexV1beta1InteractionStatusUpdate.properties.interaction_id.type - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.event_id.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.event_id.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.cached_tokens_by_modality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.cached_tokens_by_modality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.cached_tokens_by_modality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.grounding_tool_count.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.grounding_tool_count.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.grounding_tool_count.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.input_tokens_by_modality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.input_tokens_by_modality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.input_tokens_by_modality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.output_tokens_by_modality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.output_tokens_by_modality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.output_tokens_by_modality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.tool_use_tokens_by_modality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.tool_use_tokens_by_modality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.tool_use_tokens_by_modality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_cached_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_cached_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_cached_tokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_input_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_input_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_input_tokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_output_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_output_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_output_tokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_thought_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_thought_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_thought_tokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tool_use_tokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tool_use_tokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.total_tool_use_tokens.type - schemas.GenaiVertexV1beta1McpServer.properties.allowed_tools.description - schemas.GenaiVertexV1beta1McpServer.properties.allowed_tools.items.$ref - schemas.GenaiVertexV1beta1McpServer.properties.allowed_tools.type - schemas.GenaiVertexV1beta1McpServerToolCallContent.properties.server_name.description - schemas.GenaiVertexV1beta1McpServerToolCallContent.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolCallDelta.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolCallStep.properties.server_name.description - schemas.GenaiVertexV1beta1McpServerToolCallStep.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolResultContent.properties.server_name.description - schemas.GenaiVertexV1beta1McpServerToolResultContent.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.contentList.$ref - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.stringResult.type - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.structResult.$ref - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.contentList.$ref - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.server_name.description - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.server_name.type - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.stringResult.type - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.structResult.$ref - schemas.GenaiVertexV1beta1ModelInteraction.properties.generation_config.$ref - schemas.GenaiVertexV1beta1ModelInteraction.properties.generation_config.description - schemas.GenaiVertexV1beta1PlaceCitation.properties.place_id.description - schemas.GenaiVertexV1beta1PlaceCitation.properties.place_id.type - schemas.GenaiVertexV1beta1PlaceCitation.properties.review_snippets.description - schemas.GenaiVertexV1beta1PlaceCitation.properties.review_snippets.items.$ref - schemas.GenaiVertexV1beta1PlaceCitation.properties.review_snippets.type - schemas.GenaiVertexV1beta1ResponseFormatList.properties.response_formats.items.$ref - schemas.GenaiVertexV1beta1ResponseFormatList.properties.response_formats.type - schemas.GenaiVertexV1beta1Retrieval.properties.retrieval_types.description - schemas.GenaiVertexV1beta1Retrieval.properties.retrieval_types.items.enum - schemas.GenaiVertexV1beta1Retrieval.properties.retrieval_types.items.enumDescriptions - schemas.GenaiVertexV1beta1Retrieval.properties.retrieval_types.items.type - schemas.GenaiVertexV1beta1Retrieval.properties.retrieval_types.type - schemas.GenaiVertexV1beta1ReviewSnippet.properties.review_id.description - schemas.GenaiVertexV1beta1ReviewSnippet.properties.review_id.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.end_index.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.end_index.format - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.end_index.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.file_citation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.file_citation.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.place_citation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.place_citation.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.start_index.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.start_index.format - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.start_index.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.url_citation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.url_citation.description - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mime_type.description - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mime_type.enum - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mime_type.type - schemas.GenaiVertexV1beta1ToolChoiceConfig.properties.allowed_tools.$ref - schemas.GenaiVertexV1beta1ToolChoiceConfig.properties.allowed_tools.description - schemas.GenaiVertexV1beta1ToolResultContent.properties.call_id.description - schemas.GenaiVertexV1beta1ToolResultContent.properties.call_id.type - schemas.GenaiVertexV1beta1ToolResultDelta.properties.call_id.description - schemas.GenaiVertexV1beta1ToolResultDelta.properties.call_id.type - schemas.GenaiVertexV1beta1ToolResultStep.properties.call_id.description - schemas.GenaiVertexV1beta1ToolResultStep.properties.call_id.type - schemas.GenaiVertexV1beta1UrlContextResultContent.properties.is_error.description - schemas.GenaiVertexV1beta1UrlContextResultContent.properties.is_error.type - schemas.GenaiVertexV1beta1UrlContextResultDelta.properties.is_error.type - schemas.GenaiVertexV1beta1UrlContextResultStep.properties.is_error.description - schemas.GenaiVertexV1beta1UrlContextResultStep.properties.is_error.type - schemas.GenaiVertexV1beta1UserInputStep.properties.content.items.$ref - schemas.GenaiVertexV1beta1UserInputStep.properties.content.type - schemas.GenaiVertexV1beta1VideoContent.properties.mime_type.description - schemas.GenaiVertexV1beta1VideoContent.properties.mime_type.enum - schemas.GenaiVertexV1beta1VideoContent.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1VideoContent.properties.mime_type.type - schemas.GenaiVertexV1beta1VideoDelta.properties.mime_type.enum - schemas.GenaiVertexV1beta1VideoDelta.properties.mime_type.enumDescriptions - schemas.GenaiVertexV1beta1VideoDelta.properties.mime_type.type The following keys were added: - resources.interactions.methods.getPoll.parameters.includeInput.deprecated - resources.interactions.methods.getPoll.parameters.includeInput.description - resources.interactions.methods.getPoll.parameters.includeInput.location - resources.interactions.methods.getPoll.parameters.includeInput.type - resources.interactions.methods.getPoll.parameters.lastEventId.description - resources.interactions.methods.getPoll.parameters.lastEventId.location - resources.interactions.methods.getPoll.parameters.lastEventId.type - resources.interactions.methods.getStream.parameters.includeInput.deprecated - resources.interactions.methods.getStream.parameters.includeInput.description - resources.interactions.methods.getStream.parameters.includeInput.location - resources.interactions.methods.getStream.parameters.includeInput.type - resources.interactions.methods.getStream.parameters.lastEventId.description - resources.interactions.methods.getStream.parameters.lastEventId.location - resources.interactions.methods.getStream.parameters.lastEventId.type - resources.memoryBanks.methods.ingestEvents.description - resources.memoryBanks.methods.ingestEvents.flatPath - resources.memoryBanks.methods.ingestEvents.httpMethod - resources.memoryBanks.methods.ingestEvents.id - resources.memoryBanks.methods.ingestEvents.parameterOrder - resources.memoryBanks.methods.ingestEvents.parameters.parent.description - resources.memoryBanks.methods.ingestEvents.parameters.parent.location - resources.memoryBanks.methods.ingestEvents.parameters.parent.pattern - resources.memoryBanks.methods.ingestEvents.parameters.parent.required - resources.memoryBanks.methods.ingestEvents.parameters.parent.type - resources.memoryBanks.methods.ingestEvents.path - resources.memoryBanks.methods.ingestEvents.request.$ref - resources.memoryBanks.methods.ingestEvents.response.$ref - resources.memoryBanks.methods.ingestEvents.scopes - resources.memoryBanks.resources.memories.methods.create.description - resources.memoryBanks.resources.memories.methods.create.flatPath - resources.memoryBanks.resources.memories.methods.create.httpMethod - resources.memoryBanks.resources.memories.methods.create.id - resources.memoryBanks.resources.memories.methods.create.parameterOrder - resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.description - resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.location - resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.type - resources.memoryBanks.resources.memories.methods.create.parameters.parent.description - resources.memoryBanks.resources.memories.methods.create.parameters.parent.location - resources.memoryBanks.resources.memories.methods.create.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.create.parameters.parent.required - resources.memoryBanks.resources.memories.methods.create.parameters.parent.type - resources.memoryBanks.resources.memories.methods.create.path - resources.memoryBanks.resources.memories.methods.create.request.$ref - resources.memoryBanks.resources.memories.methods.create.response.$ref - resources.memoryBanks.resources.memories.methods.create.scopes - resources.memoryBanks.resources.memories.methods.delete.description - resources.memoryBanks.resources.memories.methods.delete.flatPath - resources.memoryBanks.resources.memories.methods.delete.httpMethod - resources.memoryBanks.resources.memories.methods.delete.id - resources.memoryBanks.resources.memories.methods.delete.parameterOrder - resources.memoryBanks.resources.memories.methods.delete.parameters.name.description - resources.memoryBanks.resources.memories.methods.delete.parameters.name.location - resources.memoryBanks.resources.memories.methods.delete.parameters.name.pattern - resources.memoryBanks.resources.memories.methods.delete.parameters.name.required - resources.memoryBanks.resources.memories.methods.delete.parameters.name.type - resources.memoryBanks.resources.memories.methods.delete.path - resources.memoryBanks.resources.memories.methods.delete.response.$ref - resources.memoryBanks.resources.memories.methods.delete.scopes - resources.memoryBanks.resources.memories.methods.generate.description - resources.memoryBanks.resources.memories.methods.generate.flatPath - resources.memoryBanks.resources.memories.methods.generate.httpMethod - resources.memoryBanks.resources.memories.methods.generate.id - resources.memoryBanks.resources.memories.methods.generate.parameterOrder - resources.memoryBanks.resources.memories.methods.generate.parameters.parent.description - resources.memoryBanks.resources.memories.methods.generate.parameters.parent.location - resources.memoryBanks.resources.memories.methods.generate.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.generate.parameters.parent.required - resources.memoryBanks.resources.memories.methods.generate.parameters.parent.type - resources.memoryBanks.resources.memories.methods.generate.path - resources.memoryBanks.resources.memories.methods.generate.request.$ref - resources.memoryBanks.resources.memories.methods.generate.response.$ref - resources.memoryBanks.resources.memories.methods.generate.scopes - resources.memoryBanks.resources.memories.methods.get.description - resources.memoryBanks.resources.memories.methods.get.flatPath - resources.memoryBanks.resources.memories.methods.get.httpMethod - resources.memoryBanks.resources.memories.methods.get.id - resources.memoryBanks.resources.memories.methods.get.parameterOrder - resources.memoryBanks.resources.memories.methods.get.parameters.name.description - resources.memoryBanks.resources.memories.methods.get.parameters.name.location - resources.memoryBanks.resources.memories.methods.get.parameters.name.pattern - resources.memoryBanks.resources.memories.methods.get.parameters.name.required - resources.memoryBanks.resources.memories.methods.get.parameters.name.type - resources.memoryBanks.resources.memories.methods.get.path - resources.memoryBanks.resources.memories.methods.get.response.$ref - resources.memoryBanks.resources.memories.methods.get.scopes - resources.memoryBanks.resources.memories.methods.list.description - resources.memoryBanks.resources.memories.methods.list.flatPath - resources.memoryBanks.resources.memories.methods.list.httpMethod - resources.memoryBanks.resources.memories.methods.list.id - resources.memoryBanks.resources.memories.methods.list.parameterOrder - resources.memoryBanks.resources.memories.methods.list.parameters.filter.description - resources.memoryBanks.resources.memories.methods.list.parameters.filter.location - resources.memoryBanks.resources.memories.methods.list.parameters.filter.type - resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.description - resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.location - resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.type - resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.memories.methods.list.parameters.parent.description - resources.memoryBanks.resources.memories.methods.list.parameters.parent.location - resources.memoryBanks.resources.memories.methods.list.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.list.parameters.parent.required - resources.memoryBanks.resources.memories.methods.list.parameters.parent.type - resources.memoryBanks.resources.memories.methods.list.path - resources.memoryBanks.resources.memories.methods.list.response.$ref - resources.memoryBanks.resources.memories.methods.list.scopes - resources.memoryBanks.resources.memories.methods.patch.description - resources.memoryBanks.resources.memories.methods.patch.flatPath - resources.memoryBanks.resources.memories.methods.patch.httpMethod - resources.memoryBanks.resources.memories.methods.patch.id - resources.memoryBanks.resources.memories.methods.patch.parameterOrder - resources.memoryBanks.resources.memories.methods.patch.parameters.name.description - resources.memoryBanks.resources.memories.methods.patch.parameters.name.location - resources.memoryBanks.resources.memories.methods.patch.parameters.name.pattern - resources.memoryBanks.resources.memories.methods.patch.parameters.name.required - resources.memoryBanks.resources.memories.methods.patch.parameters.name.type - resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.description - resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.format - resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.location - resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.type - resources.memoryBanks.resources.memories.methods.patch.path - resources.memoryBanks.resources.memories.methods.patch.request.$ref - resources.memoryBanks.resources.memories.methods.patch.response.$ref - resources.memoryBanks.resources.memories.methods.patch.scopes - resources.memoryBanks.resources.memories.methods.purge.description - resources.memoryBanks.resources.memories.methods.purge.flatPath - resources.memoryBanks.resources.memories.methods.purge.httpMethod - resources.memoryBanks.resources.memories.methods.purge.id - resources.memoryBanks.resources.memories.methods.purge.parameterOrder - resources.memoryBanks.resources.memories.methods.purge.parameters.parent.description - resources.memoryBanks.resources.memories.methods.purge.parameters.parent.location - resources.memoryBanks.resources.memories.methods.purge.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.purge.parameters.parent.required - resources.memoryBanks.resources.memories.methods.purge.parameters.parent.type - resources.memoryBanks.resources.memories.methods.purge.path - resources.memoryBanks.resources.memories.methods.purge.request.$ref - resources.memoryBanks.resources.memories.methods.purge.response.$ref - resources.memoryBanks.resources.memories.methods.purge.scopes - resources.memoryBanks.resources.memories.methods.retrieve.description - resources.memoryBanks.resources.memories.methods.retrieve.flatPath - resources.memoryBanks.resources.memories.methods.retrieve.httpMethod - resources.memoryBanks.resources.memories.methods.retrieve.id - resources.memoryBanks.resources.memories.methods.retrieve.parameterOrder - resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.description - resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.location - resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.required - resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.type - resources.memoryBanks.resources.memories.methods.retrieve.path - resources.memoryBanks.resources.memories.methods.retrieve.request.$ref - resources.memoryBanks.resources.memories.methods.retrieve.response.$ref - resources.memoryBanks.resources.memories.methods.retrieve.scopes - resources.memoryBanks.resources.memories.methods.retrieveProfiles.description - resources.memoryBanks.resources.memories.methods.retrieveProfiles.flatPath - resources.memoryBanks.resources.memories.methods.retrieveProfiles.httpMethod - resources.memoryBanks.resources.memories.methods.retrieveProfiles.id - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameterOrder - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.description - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.location - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.pattern - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.required - resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.type - resources.memoryBanks.resources.memories.methods.retrieveProfiles.path - resources.memoryBanks.resources.memories.methods.retrieveProfiles.request.$ref - resources.memoryBanks.resources.memories.methods.retrieveProfiles.response.$ref - resources.memoryBanks.resources.memories.methods.retrieveProfiles.scopes - resources.memoryBanks.resources.memories.methods.rollback.description - resources.memoryBanks.resources.memories.methods.rollback.flatPath - resources.memoryBanks.resources.memories.methods.rollback.httpMethod - resources.memoryBanks.resources.memories.methods.rollback.id - resources.memoryBanks.resources.memories.methods.rollback.parameterOrder - resources.memoryBanks.resources.memories.methods.rollback.parameters.name.description - resources.memoryBanks.resources.memories.methods.rollback.parameters.name.location - resources.memoryBanks.resources.memories.methods.rollback.parameters.name.pattern - resources.memoryBanks.resources.memories.methods.rollback.parameters.name.required - resources.memoryBanks.resources.memories.methods.rollback.parameters.name.type - resources.memoryBanks.resources.memories.methods.rollback.path - resources.memoryBanks.resources.memories.methods.rollback.request.$ref - resources.memoryBanks.resources.memories.methods.rollback.response.$ref - resources.memoryBanks.resources.memories.methods.rollback.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.description - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.id - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.path - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.delete.description - resources.memoryBanks.resources.memories.resources.operations.methods.delete.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.delete.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.delete.id - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.delete.path - resources.memoryBanks.resources.memories.resources.operations.methods.delete.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.delete.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.get.description - resources.memoryBanks.resources.memories.resources.operations.methods.get.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.get.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.get.id - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.get.path - resources.memoryBanks.resources.memories.resources.operations.methods.get.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.get.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.list.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.list.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.list.id - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.path - resources.memoryBanks.resources.memories.resources.operations.methods.list.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.list.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.wait.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.wait.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.wait.id - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.format - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.location - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.type - resources.memoryBanks.resources.memories.resources.operations.methods.wait.path - resources.memoryBanks.resources.memories.resources.operations.methods.wait.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.wait.scopes - resources.memoryBanks.resources.memories.resources.revisions.methods.get.description - resources.memoryBanks.resources.memories.resources.revisions.methods.get.flatPath - resources.memoryBanks.resources.memories.resources.revisions.methods.get.httpMethod - resources.memoryBanks.resources.memories.resources.revisions.methods.get.id - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameterOrder - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.description - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.location - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.required - resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.type - resources.memoryBanks.resources.memories.resources.revisions.methods.get.path - resources.memoryBanks.resources.memories.resources.revisions.methods.get.response.$ref - resources.memoryBanks.resources.memories.resources.revisions.methods.get.scopes - resources.memoryBanks.resources.memories.resources.revisions.methods.list.description - resources.memoryBanks.resources.memories.resources.revisions.methods.list.flatPath - resources.memoryBanks.resources.memories.resources.revisions.methods.list.httpMethod - resources.memoryBanks.resources.memories.resources.revisions.methods.list.id - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameterOrder - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.description - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.location - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.type - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.description - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.location - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.pattern - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.required - resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.type - resources.memoryBanks.resources.memories.resources.revisions.methods.list.path - resources.memoryBanks.resources.memories.resources.revisions.methods.list.response.$ref - resources.memoryBanks.resources.memories.resources.revisions.methods.list.scopes - resources.memoryBanks.resources.operations.methods.cancel.description - resources.memoryBanks.resources.operations.methods.cancel.flatPath - resources.memoryBanks.resources.operations.methods.cancel.httpMethod - resources.memoryBanks.resources.operations.methods.cancel.id - resources.memoryBanks.resources.operations.methods.cancel.parameterOrder - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.description - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.location - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.required - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.type - resources.memoryBanks.resources.operations.methods.cancel.path - resources.memoryBanks.resources.operations.methods.cancel.response.$ref - resources.memoryBanks.resources.operations.methods.cancel.scopes - resources.memoryBanks.resources.operations.methods.delete.description - resources.memoryBanks.resources.operations.methods.delete.flatPath - resources.memoryBanks.resources.operations.methods.delete.httpMethod - resources.memoryBanks.resources.operations.methods.delete.id - resources.memoryBanks.resources.operations.methods.delete.parameterOrder - resources.memoryBanks.resources.operations.methods.delete.parameters.name.description - resources.memoryBanks.resources.operations.methods.delete.parameters.name.location - resources.memoryBanks.resources.operations.methods.delete.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.delete.parameters.name.required - resources.memoryBanks.resources.operations.methods.delete.parameters.name.type - resources.memoryBanks.resources.operations.methods.delete.path - resources.memoryBanks.resources.operations.methods.delete.response.$ref - resources.memoryBanks.resources.operations.methods.delete.scopes - resources.memoryBanks.resources.operations.methods.get.description - resources.memoryBanks.resources.operations.methods.get.flatPath - resources.memoryBanks.resources.operations.methods.get.httpMethod - resources.memoryBanks.resources.operations.methods.get.id - resources.memoryBanks.resources.operations.methods.get.parameterOrder - resources.memoryBanks.resources.operations.methods.get.parameters.name.description - resources.memoryBanks.resources.operations.methods.get.parameters.name.location - resources.memoryBanks.resources.operations.methods.get.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.get.parameters.name.required - resources.memoryBanks.resources.operations.methods.get.parameters.name.type - resources.memoryBanks.resources.operations.methods.get.path - resources.memoryBanks.resources.operations.methods.get.response.$ref - resources.memoryBanks.resources.operations.methods.get.scopes - resources.memoryBanks.resources.operations.methods.list.description - resources.memoryBanks.resources.operations.methods.list.flatPath - resources.memoryBanks.resources.operations.methods.list.httpMethod - resources.memoryBanks.resources.operations.methods.list.id - resources.memoryBanks.resources.operations.methods.list.parameterOrder - resources.memoryBanks.resources.operations.methods.list.parameters.filter.description - resources.memoryBanks.resources.operations.methods.list.parameters.filter.location - resources.memoryBanks.resources.operations.methods.list.parameters.filter.type - resources.memoryBanks.resources.operations.methods.list.parameters.name.description - resources.memoryBanks.resources.operations.methods.list.parameters.name.location - resources.memoryBanks.resources.operations.methods.list.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.list.parameters.name.required - resources.memoryBanks.resources.operations.methods.list.parameters.name.type - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.memoryBanks.resources.operations.methods.list.path - resources.memoryBanks.resources.operations.methods.list.response.$ref - resources.memoryBanks.resources.operations.methods.list.scopes - resources.memoryBanks.resources.operations.methods.wait.description - resources.memoryBanks.resources.operations.methods.wait.flatPath - resources.memoryBanks.resources.operations.methods.wait.httpMethod - resources.memoryBanks.resources.operations.methods.wait.id - resources.memoryBanks.resources.operations.methods.wait.parameterOrder - resources.memoryBanks.resources.operations.methods.wait.parameters.name.description - resources.memoryBanks.resources.operations.methods.wait.parameters.name.location - resources.memoryBanks.resources.operations.methods.wait.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.wait.parameters.name.required - resources.memoryBanks.resources.operations.methods.wait.parameters.name.type - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.description - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.format - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.location - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.type - resources.memoryBanks.resources.operations.methods.wait.path - resources.memoryBanks.resources.operations.methods.wait.response.$ref - resources.memoryBanks.resources.operations.methods.wait.scopes - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.description - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.flatPath - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.httpMethod - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.id - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameterOrder - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.description - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.location - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.pattern - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.required - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.type - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.path - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.response.$ref - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.scopes - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.flatPath - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.httpMethod - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.id - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameterOrder - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.location - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.pattern - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.required - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.type - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.format - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.location - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.type - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.path - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.request.$ref - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.response.$ref - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.scopes - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.flatPath - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.httpMethod - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.id - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameterOrder - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.agentAnomalyDetectionScopeId.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.agentAnomalyDetectionScopeId.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.agentAnomalyDetectionScopeId.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.path - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.request.$ref - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.response.$ref - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.create.scopes - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.flatPath - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.httpMethod - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.id - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameterOrder - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.path - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.response.$ref - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.delete.scopes - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.flatPath - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.httpMethod - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.id - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameterOrder - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameters.name.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameters.name.required - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.parameters.name.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.path - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.response.$ref - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.get.scopes - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.flatPath - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.httpMethod - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.id - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameterOrder - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.path - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.response.$ref - resources.projects.resources.locations.resources.agentAnomalyDetectionScopes.methods.list.scopes - resources.projects.resources.locations.resources.evaluationSets.methods.import.description - resources.projects.resources.locations.resources.evaluationSets.methods.import.flatPath - resources.projects.resources.locations.resources.evaluationSets.methods.import.httpMethod - resources.projects.resources.locations.resources.evaluationSets.methods.import.id - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameterOrder - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.location - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.pattern - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.required - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.type - resources.projects.resources.locations.resources.evaluationSets.methods.import.path - resources.projects.resources.locations.resources.evaluationSets.methods.import.request.$ref - resources.projects.resources.locations.resources.evaluationSets.methods.import.response.$ref - resources.projects.resources.locations.resources.evaluationSets.methods.import.scopes - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.description - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.format - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.location - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.type - resources.projects.resources.locations.resources.interactions.methods.delete.description - resources.projects.resources.locations.resources.interactions.methods.delete.flatPath - resources.projects.resources.locations.resources.interactions.methods.delete.httpMethod - resources.projects.resources.locations.resources.interactions.methods.delete.id - resources.projects.resources.locations.resources.interactions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.interactions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.interactions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.interactions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.interactions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.interactions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.interactions.methods.delete.path - resources.projects.resources.locations.resources.interactions.methods.delete.response.$ref - resources.projects.resources.locations.resources.interactions.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.description - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.flatPath - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.httpMethod - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.id - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.path - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.request.$ref - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.response.$ref - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieveProfiles.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.description - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.flatPath - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.id - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameters.name.description - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameters.name.location - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameters.name.pattern - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameters.name.required - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.parameters.name.type - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.path - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.request.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.disable.scopes - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.description - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.flatPath - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.id - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameters.name.description - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameters.name.location - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameters.name.pattern - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameters.name.required - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.parameters.name.type - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.path - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.request.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.enable.scopes - resources.projects.resources.locations.resources.monitoredAgents.methods.get.description - resources.projects.resources.locations.resources.monitoredAgents.methods.get.flatPath - resources.projects.resources.locations.resources.monitoredAgents.methods.get.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.methods.get.id - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameters.name.description - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameters.name.location - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameters.name.required - resources.projects.resources.locations.resources.monitoredAgents.methods.get.parameters.name.type - resources.projects.resources.locations.resources.monitoredAgents.methods.get.path - resources.projects.resources.locations.resources.monitoredAgents.methods.get.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.get.scopes - resources.projects.resources.locations.resources.monitoredAgents.methods.list.description - resources.projects.resources.locations.resources.monitoredAgents.methods.list.flatPath - resources.projects.resources.locations.resources.monitoredAgents.methods.list.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.methods.list.id - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.monitoredAgents.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.monitoredAgents.methods.list.path - resources.projects.resources.locations.resources.monitoredAgents.methods.list.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.methods.list.scopes - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.flatPath - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.id - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.filter.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.filter.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.filter.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageSize.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageSize.format - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageSize.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageSize.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageToken.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageToken.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.pageToken.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.parent.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.parent.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.parent.pattern - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.parent.required - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.parameters.parent.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.path - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.aggregate.scopes - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.flatPath - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.id - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.view.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.view.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.parameters.view.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.path - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.get.scopes - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.flatPath - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.id - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.view.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.view.enum - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.view.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.parameters.view.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.path - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.methods.list.scopes - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.flatPath - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.id - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.path - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.get.scopes - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.flatPath - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.httpMethod - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.id - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameterOrder - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.path - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.response.$ref - resources.projects.resources.locations.resources.monitoredAgents.resources.analyzedSessions.resources.analyzedInvocations.methods.list.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.id - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.location - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.type - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.location - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.required - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.type - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.path - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.request.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.id - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.required - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.path - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.request.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.id - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.path - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.delete.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.id - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameters.name.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameters.name.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameters.name.required - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.parameters.name.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.path - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.get.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view.enum - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view.enumDescriptions - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view.location - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.view.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.create.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.delete.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.get.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.getFeedbackContext.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.list.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.patch.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.id - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.updateMask.description - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.updateMask.format - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.updateMask.location - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.parameters.updateMask.type - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.path - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.feedbackEntries.methods.updateFeedbackContext.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.id - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.path - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.id - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.path - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.scopes - resources.projects.resources.locations.resources.servingProfiles.methods.create.description - resources.projects.resources.locations.resources.servingProfiles.methods.create.flatPath - resources.projects.resources.locations.resources.servingProfiles.methods.create.httpMethod - resources.projects.resources.locations.resources.servingProfiles.methods.create.id - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.servingProfileId.description - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.servingProfileId.location - resources.projects.resources.locations.resources.servingProfiles.methods.create.parameters.servingProfileId.type - resources.projects.resources.locations.resources.servingProfiles.methods.create.path - resources.projects.resources.locations.resources.servingProfiles.methods.create.request.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.create.response.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.create.scopes - resources.projects.resources.locations.resources.servingProfiles.methods.delete.description - resources.projects.resources.locations.resources.servingProfiles.methods.delete.flatPath - resources.projects.resources.locations.resources.servingProfiles.methods.delete.httpMethod - resources.projects.resources.locations.resources.servingProfiles.methods.delete.id - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.methods.delete.path - resources.projects.resources.locations.resources.servingProfiles.methods.delete.response.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.delete.scopes - resources.projects.resources.locations.resources.servingProfiles.methods.get.description - resources.projects.resources.locations.resources.servingProfiles.methods.get.flatPath - resources.projects.resources.locations.resources.servingProfiles.methods.get.httpMethod - resources.projects.resources.locations.resources.servingProfiles.methods.get.id - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.methods.get.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.methods.get.path - resources.projects.resources.locations.resources.servingProfiles.methods.get.response.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.get.scopes - resources.projects.resources.locations.resources.servingProfiles.methods.list.description - resources.projects.resources.locations.resources.servingProfiles.methods.list.flatPath - resources.projects.resources.locations.resources.servingProfiles.methods.list.httpMethod - resources.projects.resources.locations.resources.servingProfiles.methods.list.id - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.servingProfiles.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.servingProfiles.methods.list.path - resources.projects.resources.locations.resources.servingProfiles.methods.list.response.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.list.scopes - resources.projects.resources.locations.resources.servingProfiles.methods.patch.description - resources.projects.resources.locations.resources.servingProfiles.methods.patch.flatPath - resources.projects.resources.locations.resources.servingProfiles.methods.patch.httpMethod - resources.projects.resources.locations.resources.servingProfiles.methods.patch.id - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.servingProfiles.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.servingProfiles.methods.patch.path - resources.projects.resources.locations.resources.servingProfiles.methods.patch.request.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.patch.response.$ref - resources.projects.resources.locations.resources.servingProfiles.methods.patch.scopes - resources.projects.resources.locations.resources.tuningJobs.methods.processData.description - resources.projects.resources.locations.resources.tuningJobs.methods.processData.flatPath - resources.projects.resources.locations.resources.tuningJobs.methods.processData.httpMethod - resources.projects.resources.locations.resources.tuningJobs.methods.processData.id - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameters.parent.description - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameters.parent.location - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameters.parent.pattern - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameters.parent.required - resources.projects.resources.locations.resources.tuningJobs.methods.processData.parameters.parent.type - resources.projects.resources.locations.resources.tuningJobs.methods.processData.path - resources.projects.resources.locations.resources.tuningJobs.methods.processData.request.$ref - resources.projects.resources.locations.resources.tuningJobs.methods.processData.response.$ref - resources.projects.resources.locations.resources.tuningJobs.methods.processData.scopes - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.description - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.flatPath - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.httpMethod - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.id - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameters.parent.description - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameters.parent.location - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameters.parent.pattern - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameters.parent.required - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.parameters.parent.type - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.path - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.request.$ref - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.response.$ref - resources.projects.resources.locations.resources.tuningJobs.methods.validateReinforcementTuningReward.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.scopes - resources.tuningJobs.resources.operations.methods.cancel.description - resources.tuningJobs.resources.operations.methods.cancel.flatPath - resources.tuningJobs.resources.operations.methods.cancel.httpMethod - resources.tuningJobs.resources.operations.methods.cancel.id - resources.tuningJobs.resources.operations.methods.cancel.parameterOrder - resources.tuningJobs.resources.operations.methods.cancel.parameters.name.description - resources.tuningJobs.resources.operations.methods.cancel.parameters.name.location - resources.tuningJobs.resources.operations.methods.cancel.parameters.name.pattern - resources.tuningJobs.resources.operations.methods.cancel.parameters.name.required - resources.tuningJobs.resources.operations.methods.cancel.parameters.name.type - resources.tuningJobs.resources.operations.methods.cancel.path - resources.tuningJobs.resources.operations.methods.cancel.response.$ref - resources.tuningJobs.resources.operations.methods.cancel.scopes - resources.tuningJobs.resources.operations.methods.get.description - resources.tuningJobs.resources.operations.methods.get.flatPath - resources.tuningJobs.resources.operations.methods.get.httpMethod - resources.tuningJobs.resources.operations.methods.get.id - resources.tuningJobs.resources.operations.methods.get.parameterOrder - resources.tuningJobs.resources.operations.methods.get.parameters.name.description - resources.tuningJobs.resources.operations.methods.get.parameters.name.location - resources.tuningJobs.resources.operations.methods.get.parameters.name.pattern - resources.tuningJobs.resources.operations.methods.get.parameters.name.required - resources.tuningJobs.resources.operations.methods.get.parameters.name.type - resources.tuningJobs.resources.operations.methods.get.path - resources.tuningJobs.resources.operations.methods.get.response.$ref - resources.tuningJobs.resources.operations.methods.get.scopes - resources.tuningJobs.resources.operations.methods.wait.description - resources.tuningJobs.resources.operations.methods.wait.flatPath - resources.tuningJobs.resources.operations.methods.wait.httpMethod - resources.tuningJobs.resources.operations.methods.wait.id - resources.tuningJobs.resources.operations.methods.wait.parameterOrder - resources.tuningJobs.resources.operations.methods.wait.parameters.name.description - resources.tuningJobs.resources.operations.methods.wait.parameters.name.location - resources.tuningJobs.resources.operations.methods.wait.parameters.name.pattern - resources.tuningJobs.resources.operations.methods.wait.parameters.name.required - resources.tuningJobs.resources.operations.methods.wait.parameters.name.type - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.description - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.format - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.location - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.type - resources.tuningJobs.resources.operations.methods.wait.path - resources.tuningJobs.resources.operations.methods.wait.response.$ref - resources.tuningJobs.resources.operations.methods.wait.scopes - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.anchorLastFrame.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.anchorLastFrame.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.additionalProperties.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.additionalProperties.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.originalRequestJson.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.originalRequestJson.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.schedulingConfig.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.schedulingConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.seamless.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.seamless.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.properties.enable.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.properties.enable.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.properties.enable.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.properties.enable.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.properties.enableRetry.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.properties.enableRetry.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.type - schemas.CloudAiLargeModelsVisionSeamless.id - schemas.CloudAiLargeModelsVisionSeamless.properties.loop.description - schemas.CloudAiLargeModelsVisionSeamless.properties.loop.type - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateHorizontal.description - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateHorizontal.type - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateVertical.description - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateVertical.type - schemas.CloudAiLargeModelsVisionSeamless.type - schemas.GenaiVertexV1beta1AgentInteraction.properties.antigravityConfig.$ref - schemas.GenaiVertexV1beta1AgentInteraction.properties.antigravityConfig.description - schemas.GenaiVertexV1beta1AgentInteraction.properties.codeMenderConfig.$ref - schemas.GenaiVertexV1beta1AgentInteraction.properties.deepResearchConfig.$ref - schemas.GenaiVertexV1beta1AgentInteraction.properties.dynamicConfig.$ref - schemas.GenaiVertexV1beta1AntigravityAgentConfig.description - schemas.GenaiVertexV1beta1AntigravityAgentConfig.id - schemas.GenaiVertexV1beta1AntigravityAgentConfig.properties.maxTotalTokens.description - schemas.GenaiVertexV1beta1AntigravityAgentConfig.properties.maxTotalTokens.format - schemas.GenaiVertexV1beta1AntigravityAgentConfig.properties.maxTotalTokens.type - schemas.GenaiVertexV1beta1AntigravityAgentConfig.properties.model.description - schemas.GenaiVertexV1beta1AntigravityAgentConfig.properties.model.type - schemas.GenaiVertexV1beta1AntigravityAgentConfig.type - schemas.GenaiVertexV1beta1ArgumentsDelta.properties.arguments.type - schemas.GenaiVertexV1beta1AudioContent.properties.mimeType.description - schemas.GenaiVertexV1beta1AudioContent.properties.mimeType.enum - schemas.GenaiVertexV1beta1AudioContent.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1AudioContent.properties.mimeType.type - schemas.GenaiVertexV1beta1AudioContent.properties.sampleRate.description - schemas.GenaiVertexV1beta1AudioContent.properties.sampleRate.format - schemas.GenaiVertexV1beta1AudioContent.properties.sampleRate.type - schemas.GenaiVertexV1beta1AudioDelta.properties.mimeType.enum - schemas.GenaiVertexV1beta1AudioDelta.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1AudioDelta.properties.mimeType.type - schemas.GenaiVertexV1beta1AudioDelta.properties.sampleRate.description - schemas.GenaiVertexV1beta1AudioDelta.properties.sampleRate.format - schemas.GenaiVertexV1beta1AudioDelta.properties.sampleRate.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bitRate.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bitRate.format - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.bitRate.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mimeType.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mimeType.enum - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.mimeType.type - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sampleRate.description - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sampleRate.format - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.sampleRate.type - schemas.GenaiVertexV1beta1CodeExecutionCallContent.deprecated - schemas.GenaiVertexV1beta1CodeExecutionResultContent.deprecated - schemas.GenaiVertexV1beta1CodeExecutionResultContent.properties.isError.description - schemas.GenaiVertexV1beta1CodeExecutionResultContent.properties.isError.type - schemas.GenaiVertexV1beta1CodeExecutionResultDelta.properties.isError.type - schemas.GenaiVertexV1beta1CodeExecutionResultStep.properties.isError.description - schemas.GenaiVertexV1beta1CodeExecutionResultStep.properties.isError.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.id - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.find_request.$ref - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.find_request.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.fix_request.$ref - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.fix_request.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.model.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.model.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.session_config.$ref - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.session_config.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.session_id.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.properties.session_id.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfig.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.id - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.properties.content.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.properties.content.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.properties.path.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.properties.path.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFileContent.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.id - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.description.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.description.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.finding_id.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.finding_id.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.mode.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.mode.enum - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.mode.enumDescriptions - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.mode.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.source_files.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.source_files.items.$ref - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.properties.source_files.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFindRequest.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.id - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.description.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.description.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.finding_id.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.finding_id.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.source_files.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.source_files.items.$ref - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.properties.source_files.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigFixRequest.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.id - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.properties.max_rounds.description - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.properties.max_rounds.format - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.properties.max_rounds.type - schemas.GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig.type - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies.description - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies.items.enum - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies.items.enumDescriptions - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies.items.type - schemas.GenaiVertexV1beta1ComputerUse.properties.disabledSafetyPolicies.type - schemas.GenaiVertexV1beta1ComputerUse.properties.enablePromptInjectionDetection.description - schemas.GenaiVertexV1beta1ComputerUse.properties.enablePromptInjectionDetection.type - schemas.GenaiVertexV1beta1ComputerUse.properties.excludedPredefinedFunctions.description - schemas.GenaiVertexV1beta1ComputerUse.properties.excludedPredefinedFunctions.items.type - schemas.GenaiVertexV1beta1ComputerUse.properties.excludedPredefinedFunctions.type - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.collaborativePlanning.description - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.collaborativePlanning.type - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.enableBigqueryTool.description - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.enableBigqueryTool.type - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinkingSummaries.description - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinkingSummaries.enum - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinkingSummaries.enumDescriptions - schemas.GenaiVertexV1beta1DeepResearchAgentConfig.properties.thinkingSummaries.type - schemas.GenaiVertexV1beta1DeleteInteractionResponse.description - schemas.GenaiVertexV1beta1DeleteInteractionResponse.id - schemas.GenaiVertexV1beta1DeleteInteractionResponse.type - schemas.GenaiVertexV1beta1DocumentContent.properties.mimeType.description - schemas.GenaiVertexV1beta1DocumentContent.properties.mimeType.enum - schemas.GenaiVertexV1beta1DocumentContent.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1DocumentContent.properties.mimeType.type - schemas.GenaiVertexV1beta1DocumentDelta.properties.mimeType.enum - schemas.GenaiVertexV1beta1DocumentDelta.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1DocumentDelta.properties.mimeType.type - schemas.GenaiVertexV1beta1EnvironmentConfig.description - schemas.GenaiVertexV1beta1EnvironmentConfig.id - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.environmentId.description - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.environmentId.type - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkAllowlist.$ref - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkAllowlist.description - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkMode.description - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkMode.enum - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkMode.enumDescriptions - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.networkMode.type - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.sources.items.$ref - schemas.GenaiVertexV1beta1EnvironmentConfig.properties.sources.type - schemas.GenaiVertexV1beta1EnvironmentConfig.type - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.description - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.id - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.properties.domain.description - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.properties.domain.type - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.properties.transform.additionalProperties.type - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.properties.transform.description - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.properties.transform.type - schemas.GenaiVertexV1beta1EnvironmentConfigEgressRule.type - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.description - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.id - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.properties.allowlist.description - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.properties.allowlist.items.$ref - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.properties.allowlist.type - schemas.GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.description - schemas.GenaiVertexV1beta1EnvironmentConfigSource.id - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.content.description - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.content.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.encoding.description - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.encoding.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.source.description - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.source.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.target.description - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.target.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.type.enum - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.type.enumDescriptions - schemas.GenaiVertexV1beta1EnvironmentConfigSource.properties.type.type - schemas.GenaiVertexV1beta1EnvironmentConfigSource.type - schemas.GenaiVertexV1beta1ExaAISearchConfig.description - schemas.GenaiVertexV1beta1ExaAISearchConfig.id - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.api_key.description - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.api_key.type - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.custom_config.additionalProperties.description - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.custom_config.additionalProperties.type - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.custom_config.description - schemas.GenaiVertexV1beta1ExaAISearchConfig.properties.custom_config.type - schemas.GenaiVertexV1beta1ExaAISearchConfig.type - schemas.GenaiVertexV1beta1Field.description - schemas.GenaiVertexV1beta1Field.id - schemas.GenaiVertexV1beta1Field.properties.name.type - schemas.GenaiVertexV1beta1Field.properties.value.$ref - schemas.GenaiVertexV1beta1Field.type - schemas.GenaiVertexV1beta1FileCitation.properties.customMetadata.$ref - schemas.GenaiVertexV1beta1FileCitation.properties.customMetadata.description - schemas.GenaiVertexV1beta1FileCitation.properties.documentUri.description - schemas.GenaiVertexV1beta1FileCitation.properties.documentUri.type - schemas.GenaiVertexV1beta1FileCitation.properties.fileName.description - schemas.GenaiVertexV1beta1FileCitation.properties.fileName.type - schemas.GenaiVertexV1beta1FileCitation.properties.mediaId.description - schemas.GenaiVertexV1beta1FileCitation.properties.mediaId.type - schemas.GenaiVertexV1beta1FileCitation.properties.pageNumber.description - schemas.GenaiVertexV1beta1FileCitation.properties.pageNumber.format - schemas.GenaiVertexV1beta1FileCitation.properties.pageNumber.type - schemas.GenaiVertexV1beta1FileSearch.properties.fileSearchStoreNames.description - schemas.GenaiVertexV1beta1FileSearch.properties.fileSearchStoreNames.items.type - schemas.GenaiVertexV1beta1FileSearch.properties.fileSearchStoreNames.type - schemas.GenaiVertexV1beta1FileSearch.properties.metadataFilter.description - schemas.GenaiVertexV1beta1FileSearch.properties.metadataFilter.type - schemas.GenaiVertexV1beta1FileSearch.properties.topK.description - schemas.GenaiVertexV1beta1FileSearch.properties.topK.format - schemas.GenaiVertexV1beta1FileSearch.properties.topK.type - schemas.GenaiVertexV1beta1FileSearchCallContent.deprecated - schemas.GenaiVertexV1beta1FileSearchResultContent.deprecated - schemas.GenaiVertexV1beta1FunctionCallContent.deprecated - schemas.GenaiVertexV1beta1FunctionResultContent.deprecated - schemas.GenaiVertexV1beta1FunctionResultContent.properties.isError.description - schemas.GenaiVertexV1beta1FunctionResultContent.properties.isError.type - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.isError.type - schemas.GenaiVertexV1beta1FunctionResultDelta.properties.result.$ref - schemas.GenaiVertexV1beta1FunctionResultStep.properties.isError.description - schemas.GenaiVertexV1beta1FunctionResultStep.properties.isError.type - schemas.GenaiVertexV1beta1FunctionResultStep.properties.result.$ref - schemas.GenaiVertexV1beta1FunctionResultStep.properties.result.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.imageConfig.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.imageConfig.deprecated - schemas.GenaiVertexV1beta1GenerationConfig.properties.imageConfig.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.maxOutputTokens.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.maxOutputTokens.format - schemas.GenaiVertexV1beta1GenerationConfig.properties.maxOutputTokens.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.speechConfig.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.speechConfig.items.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.speechConfig.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.stopSequences.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.stopSequences.items.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.stopSequences.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingLevel.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingLevel.enum - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingLevel.enumDescriptions - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingLevel.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingSummaries.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingSummaries.enum - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingSummaries.enumDescriptions - schemas.GenaiVertexV1beta1GenerationConfig.properties.thinkingSummaries.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.topP.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.topP.format - schemas.GenaiVertexV1beta1GenerationConfig.properties.topP.type - schemas.GenaiVertexV1beta1GenerationConfig.properties.transcriptionConfig.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.transcriptionConfig.description - schemas.GenaiVertexV1beta1GenerationConfig.properties.videoConfig.$ref - schemas.GenaiVertexV1beta1GenerationConfig.properties.videoConfig.description - schemas.GenaiVertexV1beta1GoogleMaps.properties.enableWidget.description - schemas.GenaiVertexV1beta1GoogleMaps.properties.enableWidget.type - schemas.GenaiVertexV1beta1GoogleMapsCallContent.deprecated - schemas.GenaiVertexV1beta1GoogleMapsResultContent.deprecated - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult.properties.widgetContextToken.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResult.properties.widgetContextToken.type - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.placeId.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.placeId.type - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.reviewSnippets.description - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.reviewSnippets.items.$ref - schemas.GenaiVertexV1beta1GoogleMapsResultContentGoogleMapsResultPlaces.properties.reviewSnippets.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItem.properties.widgetContextToken.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.placeId.type - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.reviewSnippets.items.$ref - schemas.GenaiVertexV1beta1GoogleMapsResultStepGoogleMapsResultItemGoogleMapsResultPlaces.properties.reviewSnippets.type - schemas.GenaiVertexV1beta1GoogleSearch.properties.searchTypes.description - schemas.GenaiVertexV1beta1GoogleSearch.properties.searchTypes.items.enum - schemas.GenaiVertexV1beta1GoogleSearch.properties.searchTypes.items.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearch.properties.searchTypes.items.type - schemas.GenaiVertexV1beta1GoogleSearch.properties.searchTypes.type - schemas.GenaiVertexV1beta1GoogleSearchCallContent.deprecated - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.searchType.description - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.searchType.enum - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.searchType.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearchCallContent.properties.searchType.type - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.searchType.description - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.searchType.enum - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.searchType.enumDescriptions - schemas.GenaiVertexV1beta1GoogleSearchCallStep.properties.searchType.type - schemas.GenaiVertexV1beta1GoogleSearchResultContent.deprecated - schemas.GenaiVertexV1beta1GoogleSearchResultContent.properties.isError.description - schemas.GenaiVertexV1beta1GoogleSearchResultContent.properties.isError.type - schemas.GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult.properties.searchSuggestions.description - schemas.GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult.properties.searchSuggestions.type - schemas.GenaiVertexV1beta1GoogleSearchResultDelta.properties.isError.type - schemas.GenaiVertexV1beta1GoogleSearchResultStep.properties.isError.description - schemas.GenaiVertexV1beta1GoogleSearchResultStep.properties.isError.type - schemas.GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem.properties.searchSuggestions.description - schemas.GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem.properties.searchSuggestions.type - schemas.GenaiVertexV1beta1ImageConfig.properties.aspectRatio.description - schemas.GenaiVertexV1beta1ImageConfig.properties.aspectRatio.type - schemas.GenaiVertexV1beta1ImageConfig.properties.imageSize.description - schemas.GenaiVertexV1beta1ImageConfig.properties.imageSize.type - schemas.GenaiVertexV1beta1ImageContent.properties.mimeType.description - schemas.GenaiVertexV1beta1ImageContent.properties.mimeType.enum - schemas.GenaiVertexV1beta1ImageContent.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1ImageContent.properties.mimeType.type - schemas.GenaiVertexV1beta1ImageDelta.properties.mimeType.enum - schemas.GenaiVertexV1beta1ImageDelta.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1ImageDelta.properties.mimeType.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspectRatio.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspectRatio.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.aspectRatio.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.imageSize.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.imageSize.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.imageSize.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.imageSize.type - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mimeType.description - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mimeType.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.mimeType.type - schemas.GenaiVertexV1beta1Interaction.properties.envId.description - schemas.GenaiVertexV1beta1Interaction.properties.envId.type - schemas.GenaiVertexV1beta1Interaction.properties.environmentId.description - schemas.GenaiVertexV1beta1Interaction.properties.environmentId.readOnly - schemas.GenaiVertexV1beta1Interaction.properties.environmentId.type - schemas.GenaiVertexV1beta1Interaction.properties.labels.additionalProperties.type - schemas.GenaiVertexV1beta1Interaction.properties.labels.description - schemas.GenaiVertexV1beta1Interaction.properties.labels.type - schemas.GenaiVertexV1beta1Interaction.properties.localEnvironment.$ref - schemas.GenaiVertexV1beta1Interaction.properties.localEnvironment.description - schemas.GenaiVertexV1beta1Interaction.properties.previousInteractionId.description - schemas.GenaiVertexV1beta1Interaction.properties.previousInteractionId.type - schemas.GenaiVertexV1beta1Interaction.properties.remoteEnvironment.$ref - schemas.GenaiVertexV1beta1Interaction.properties.responseFormat.$ref - schemas.GenaiVertexV1beta1Interaction.properties.responseFormat.deprecated - schemas.GenaiVertexV1beta1Interaction.properties.responseFormat.description - schemas.GenaiVertexV1beta1Interaction.properties.responseMimeType.deprecated - schemas.GenaiVertexV1beta1Interaction.properties.responseMimeType.description - schemas.GenaiVertexV1beta1Interaction.properties.responseMimeType.type - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.deprecated - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.description - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.items.enum - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.items.enumDescriptions - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.items.type - schemas.GenaiVertexV1beta1Interaction.properties.responseModalities.type - schemas.GenaiVertexV1beta1Interaction.properties.safety_settings.description - schemas.GenaiVertexV1beta1Interaction.properties.safety_settings.items.$ref - schemas.GenaiVertexV1beta1Interaction.properties.safety_settings.type - schemas.GenaiVertexV1beta1Interaction.properties.systemInstruction.description - schemas.GenaiVertexV1beta1Interaction.properties.systemInstruction.type - schemas.GenaiVertexV1beta1InteractionStatusUpdate.properties.interactionId.type - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.eventId.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.eventId.type - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.metadata.$ref - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.metadata.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.cachedTokensByModality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.cachedTokensByModality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.cachedTokensByModality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.groundingToolCount.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.groundingToolCount.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.groundingToolCount.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.inputTokensByModality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.inputTokensByModality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.inputTokensByModality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.outputTokensByModality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.outputTokensByModality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.outputTokensByModality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.toolUseTokensByModality.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.toolUseTokensByModality.items.$ref - schemas.GenaiVertexV1beta1InteractionUsage.properties.toolUseTokensByModality.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalCachedTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalCachedTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalCachedTokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalInputTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalInputTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalInputTokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalOutputTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalOutputTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalOutputTokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalThoughtTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalThoughtTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalThoughtTokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalTokens.type - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalToolUseTokens.description - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalToolUseTokens.format - schemas.GenaiVertexV1beta1InteractionUsage.properties.totalToolUseTokens.type - schemas.GenaiVertexV1beta1ListValue.description - schemas.GenaiVertexV1beta1ListValue.id - schemas.GenaiVertexV1beta1ListValue.properties.values.description - schemas.GenaiVertexV1beta1ListValue.properties.values.items.$ref - schemas.GenaiVertexV1beta1ListValue.properties.values.type - schemas.GenaiVertexV1beta1ListValue.type - schemas.GenaiVertexV1beta1LocalEnvironmentConfig.description - schemas.GenaiVertexV1beta1LocalEnvironmentConfig.id - schemas.GenaiVertexV1beta1LocalEnvironmentConfig.type - schemas.GenaiVertexV1beta1McpServer.properties.allowedTools.description - schemas.GenaiVertexV1beta1McpServer.properties.allowedTools.items.$ref - schemas.GenaiVertexV1beta1McpServer.properties.allowedTools.type - schemas.GenaiVertexV1beta1McpServerToolCallContent.properties.serverName.description - schemas.GenaiVertexV1beta1McpServerToolCallContent.properties.serverName.type - schemas.GenaiVertexV1beta1McpServerToolCallDelta.properties.serverName.type - schemas.GenaiVertexV1beta1McpServerToolCallStep.properties.serverName.description - schemas.GenaiVertexV1beta1McpServerToolCallStep.properties.serverName.type - schemas.GenaiVertexV1beta1McpServerToolResultContent.properties.serverName.description - schemas.GenaiVertexV1beta1McpServerToolResultContent.properties.serverName.type - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.result.$ref - schemas.GenaiVertexV1beta1McpServerToolResultDelta.properties.serverName.type - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.result.$ref - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.result.description - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.serverName.description - schemas.GenaiVertexV1beta1McpServerToolResultStep.properties.serverName.type - schemas.GenaiVertexV1beta1ModelInteraction.properties.generationConfig.$ref - schemas.GenaiVertexV1beta1ModelInteraction.properties.generationConfig.description - schemas.GenaiVertexV1beta1ModelOutputStep.properties.error.$ref - schemas.GenaiVertexV1beta1ModelOutputStep.properties.error.description - schemas.GenaiVertexV1beta1ParallelAISearchConfig.description - schemas.GenaiVertexV1beta1ParallelAISearchConfig.id - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.api_key.description - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.api_key.type - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.custom_config.additionalProperties.description - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.custom_config.additionalProperties.type - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.custom_config.description - schemas.GenaiVertexV1beta1ParallelAISearchConfig.properties.custom_config.type - schemas.GenaiVertexV1beta1ParallelAISearchConfig.type - schemas.GenaiVertexV1beta1PlaceCitation.properties.placeId.description - schemas.GenaiVertexV1beta1PlaceCitation.properties.placeId.type - schemas.GenaiVertexV1beta1PlaceCitation.properties.reviewSnippets.description - schemas.GenaiVertexV1beta1PlaceCitation.properties.reviewSnippets.items.$ref - schemas.GenaiVertexV1beta1PlaceCitation.properties.reviewSnippets.type - schemas.GenaiVertexV1beta1RagStoreConfig.description - schemas.GenaiVertexV1beta1RagStoreConfig.id - schemas.GenaiVertexV1beta1RagStoreConfig.properties.rag_resources.description - schemas.GenaiVertexV1beta1RagStoreConfig.properties.rag_resources.items.$ref - schemas.GenaiVertexV1beta1RagStoreConfig.properties.rag_resources.type - schemas.GenaiVertexV1beta1RagStoreConfig.properties.rag_retrieval_config.$ref - schemas.GenaiVertexV1beta1RagStoreConfig.properties.rag_retrieval_config.description - schemas.GenaiVertexV1beta1RagStoreConfig.properties.similarity_top_k.deprecated - schemas.GenaiVertexV1beta1RagStoreConfig.properties.similarity_top_k.description - schemas.GenaiVertexV1beta1RagStoreConfig.properties.similarity_top_k.format - schemas.GenaiVertexV1beta1RagStoreConfig.properties.similarity_top_k.type - schemas.GenaiVertexV1beta1RagStoreConfig.properties.vector_distance_threshold.deprecated - schemas.GenaiVertexV1beta1RagStoreConfig.properties.vector_distance_threshold.description - schemas.GenaiVertexV1beta1RagStoreConfig.properties.vector_distance_threshold.format - schemas.GenaiVertexV1beta1RagStoreConfig.properties.vector_distance_threshold.type - schemas.GenaiVertexV1beta1RagStoreConfig.type - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.description - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.id - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.properties.rag_corpus.description - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.properties.rag_corpus.type - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.properties.rag_file_ids.description - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.properties.rag_file_ids.items.type - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.properties.rag_file_ids.type - schemas.GenaiVertexV1beta1RagStoreConfigRagResource.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.id - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.filter.$ref - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.filter.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.hybrid_search.$ref - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.hybrid_search.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.ranking.$ref - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.ranking.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.top_k.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.top_k.format - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.properties.top_k.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.id - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.metadata_filter.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.metadata_filter.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_distance_threshold.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_distance_threshold.format - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_distance_threshold.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_similarity_threshold.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_similarity_threshold.format - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.properties.vector_similarity_threshold.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.id - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.properties.alpha.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.properties.alpha.format - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.properties.alpha.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking.id - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking.properties.rank_service.$ref - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking.properties.rank_service.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService.id - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService.properties.model_name.description - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService.properties.model_name.type - schemas.GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService.type - schemas.GenaiVertexV1beta1ResponseFormatList.properties.responseFormats.items.$ref - schemas.GenaiVertexV1beta1ResponseFormatList.properties.responseFormats.type - schemas.GenaiVertexV1beta1Retrieval.properties.exa_ai_search_config.$ref - schemas.GenaiVertexV1beta1Retrieval.properties.exa_ai_search_config.description - schemas.GenaiVertexV1beta1Retrieval.properties.parallel_ai_search_config.$ref - schemas.GenaiVertexV1beta1Retrieval.properties.parallel_ai_search_config.description - schemas.GenaiVertexV1beta1Retrieval.properties.rag_store_config.$ref - schemas.GenaiVertexV1beta1Retrieval.properties.rag_store_config.description - schemas.GenaiVertexV1beta1Retrieval.properties.retrievalTypes.description - schemas.GenaiVertexV1beta1Retrieval.properties.retrievalTypes.items.enum - schemas.GenaiVertexV1beta1Retrieval.properties.retrievalTypes.items.enumDescriptions - schemas.GenaiVertexV1beta1Retrieval.properties.retrievalTypes.items.type - schemas.GenaiVertexV1beta1Retrieval.properties.retrievalTypes.type - schemas.GenaiVertexV1beta1RetrievalCallDelta.description - schemas.GenaiVertexV1beta1RetrievalCallDelta.id - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.arguments.$ref - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.arguments.description - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.retrievalType.description - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.retrievalType.enum - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.retrievalType.enumDescriptions - schemas.GenaiVertexV1beta1RetrievalCallDelta.properties.retrievalType.type - schemas.GenaiVertexV1beta1RetrievalCallDelta.type - schemas.GenaiVertexV1beta1RetrievalCallStep.description - schemas.GenaiVertexV1beta1RetrievalCallStep.id - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.arguments.$ref - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.arguments.description - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.retrievalType.description - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.retrievalType.enum - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.retrievalType.enumDescriptions - schemas.GenaiVertexV1beta1RetrievalCallStep.properties.retrievalType.type - schemas.GenaiVertexV1beta1RetrievalCallStep.type - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.description - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.id - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.properties.queries.description - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.properties.queries.items.type - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.properties.queries.type - schemas.GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments.type - schemas.GenaiVertexV1beta1RetrievalResultDelta.description - schemas.GenaiVertexV1beta1RetrievalResultDelta.id - schemas.GenaiVertexV1beta1RetrievalResultDelta.properties.isError.description - schemas.GenaiVertexV1beta1RetrievalResultDelta.properties.isError.type - schemas.GenaiVertexV1beta1RetrievalResultDelta.type - schemas.GenaiVertexV1beta1RetrievalResultStep.description - schemas.GenaiVertexV1beta1RetrievalResultStep.id - schemas.GenaiVertexV1beta1RetrievalResultStep.properties.isError.description - schemas.GenaiVertexV1beta1RetrievalResultStep.properties.isError.type - schemas.GenaiVertexV1beta1RetrievalResultStep.type - schemas.GenaiVertexV1beta1ReviewSnippet.properties.reviewId.description - schemas.GenaiVertexV1beta1ReviewSnippet.properties.reviewId.type - schemas.GenaiVertexV1beta1SafetySetting.description - schemas.GenaiVertexV1beta1SafetySetting.id - schemas.GenaiVertexV1beta1SafetySetting.properties.method.description - schemas.GenaiVertexV1beta1SafetySetting.properties.method.enum - schemas.GenaiVertexV1beta1SafetySetting.properties.method.enumDescriptions - schemas.GenaiVertexV1beta1SafetySetting.properties.method.type - schemas.GenaiVertexV1beta1SafetySetting.properties.threshold.description - schemas.GenaiVertexV1beta1SafetySetting.properties.threshold.enum - schemas.GenaiVertexV1beta1SafetySetting.properties.threshold.enumDescriptions - schemas.GenaiVertexV1beta1SafetySetting.properties.threshold.type - schemas.GenaiVertexV1beta1SafetySetting.properties.type.description - schemas.GenaiVertexV1beta1SafetySetting.properties.type.enum - schemas.GenaiVertexV1beta1SafetySetting.properties.type.enumDeprecated - schemas.GenaiVertexV1beta1SafetySetting.properties.type.enumDescriptions - schemas.GenaiVertexV1beta1SafetySetting.properties.type.type - schemas.GenaiVertexV1beta1SafetySetting.type - schemas.GenaiVertexV1beta1ServerToolCallDelta.id - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.codeExecutionCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.fileSearchCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.googleMapsCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.googleSearchCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.mcpServerToolCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.retrievalCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.signature.description - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.signature.format - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.signature.type - schemas.GenaiVertexV1beta1ServerToolCallDelta.properties.urlContextCall.$ref - schemas.GenaiVertexV1beta1ServerToolCallDelta.type - schemas.GenaiVertexV1beta1ServerToolResultDelta.id - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.codeExecutionResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.fileSearchResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.googleMapsResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.googleSearchResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.mcpServerToolResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.retrievalResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.signature.description - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.signature.format - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.signature.type - schemas.GenaiVertexV1beta1ServerToolResultDelta.properties.urlContextResult.$ref - schemas.GenaiVertexV1beta1ServerToolResultDelta.type - schemas.GenaiVertexV1beta1Step.properties.userInput.description - schemas.GenaiVertexV1beta1StepDeltaData.properties.functionResult.$ref - schemas.GenaiVertexV1beta1StepDeltaData.properties.serverToolCall.$ref - schemas.GenaiVertexV1beta1StepDeltaData.properties.serverToolResult.$ref - schemas.GenaiVertexV1beta1StepStop.properties.stepUsage.$ref - schemas.GenaiVertexV1beta1StepStop.properties.stepUsage.description - schemas.GenaiVertexV1beta1StepStop.properties.usage.$ref - schemas.GenaiVertexV1beta1StepStop.properties.usage.description - schemas.GenaiVertexV1beta1StreamMetadata.id - schemas.GenaiVertexV1beta1StreamMetadata.properties.totalUsage.$ref - schemas.GenaiVertexV1beta1StreamMetadata.type - schemas.GenaiVertexV1beta1Struct.description - schemas.GenaiVertexV1beta1Struct.id - schemas.GenaiVertexV1beta1Struct.properties.fields.description - schemas.GenaiVertexV1beta1Struct.properties.fields.items.$ref - schemas.GenaiVertexV1beta1Struct.properties.fields.type - schemas.GenaiVertexV1beta1Struct.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.endIndex.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.endIndex.format - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.endIndex.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.fileCitation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.fileCitation.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.placeCitation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.placeCitation.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.startIndex.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.startIndex.format - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.startIndex.type - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.urlCitation.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.urlCitation.description - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.wordInfo.$ref - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.wordInfo.description - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mimeType.description - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mimeType.enum - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1TextResponseFormat.properties.mimeType.type - schemas.GenaiVertexV1beta1ThoughtContent.deprecated - schemas.GenaiVertexV1beta1ToolCallContent.deprecated - schemas.GenaiVertexV1beta1ToolCallStep.properties.retrievalCall.$ref - schemas.GenaiVertexV1beta1ToolChoiceConfig.properties.allowedTools.$ref - schemas.GenaiVertexV1beta1ToolChoiceConfig.properties.allowedTools.description - schemas.GenaiVertexV1beta1ToolResultContent.deprecated - schemas.GenaiVertexV1beta1ToolResultContent.properties.callId.description - schemas.GenaiVertexV1beta1ToolResultContent.properties.callId.type - schemas.GenaiVertexV1beta1ToolResultDelta.properties.callId.description - schemas.GenaiVertexV1beta1ToolResultDelta.properties.callId.type - schemas.GenaiVertexV1beta1ToolResultStep.properties.callId.description - schemas.GenaiVertexV1beta1ToolResultStep.properties.callId.type - schemas.GenaiVertexV1beta1ToolResultStep.properties.retrievalResult.$ref - schemas.GenaiVertexV1beta1TranscriptionConfig.description - schemas.GenaiVertexV1beta1TranscriptionConfig.id - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.adaptationPhrases.deprecated - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.adaptationPhrases.description - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.adaptationPhrases.items.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.adaptationPhrases.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.customVocabulary.description - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.customVocabulary.items.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.customVocabulary.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.diarizationMode.description - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.diarizationMode.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.languageHints.description - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.languageHints.items.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.languageHints.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.timestampGranularities.description - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.timestampGranularities.items.type - schemas.GenaiVertexV1beta1TranscriptionConfig.properties.timestampGranularities.type - schemas.GenaiVertexV1beta1TranscriptionConfig.type - schemas.GenaiVertexV1beta1UrlContextCallContent.deprecated - schemas.GenaiVertexV1beta1UrlContextResultContent.deprecated - schemas.GenaiVertexV1beta1UrlContextResultContent.properties.isError.description - schemas.GenaiVertexV1beta1UrlContextResultContent.properties.isError.type - schemas.GenaiVertexV1beta1UrlContextResultDelta.properties.isError.type - schemas.GenaiVertexV1beta1UrlContextResultStep.properties.isError.description - schemas.GenaiVertexV1beta1UrlContextResultStep.properties.isError.type - schemas.GenaiVertexV1beta1UserInputStep.properties.contentList.$ref - schemas.GenaiVertexV1beta1UserInputStep.properties.contentList.description - schemas.GenaiVertexV1beta1UserInputStep.properties.contentString.description - schemas.GenaiVertexV1beta1UserInputStep.properties.contentString.type - schemas.GenaiVertexV1beta1Value.description - schemas.GenaiVertexV1beta1Value.id - schemas.GenaiVertexV1beta1Value.properties.boolValue.description - schemas.GenaiVertexV1beta1Value.properties.boolValue.type - schemas.GenaiVertexV1beta1Value.properties.contentValue.$ref - schemas.GenaiVertexV1beta1Value.properties.contentValue.description - schemas.GenaiVertexV1beta1Value.properties.listValue.$ref - schemas.GenaiVertexV1beta1Value.properties.listValue.description - schemas.GenaiVertexV1beta1Value.properties.nullValue.description - schemas.GenaiVertexV1beta1Value.properties.nullValue.enum - schemas.GenaiVertexV1beta1Value.properties.nullValue.enumDescriptions - schemas.GenaiVertexV1beta1Value.properties.nullValue.type - schemas.GenaiVertexV1beta1Value.properties.numberValue.description - schemas.GenaiVertexV1beta1Value.properties.numberValue.format - schemas.GenaiVertexV1beta1Value.properties.numberValue.type - schemas.GenaiVertexV1beta1Value.properties.stringValue.description - schemas.GenaiVertexV1beta1Value.properties.stringValue.type - schemas.GenaiVertexV1beta1Value.properties.structValue.$ref - schemas.GenaiVertexV1beta1Value.properties.structValue.description - schemas.GenaiVertexV1beta1Value.type - schemas.GenaiVertexV1beta1VideoConfig.description - schemas.GenaiVertexV1beta1VideoConfig.id - schemas.GenaiVertexV1beta1VideoConfig.properties.task.description - schemas.GenaiVertexV1beta1VideoConfig.properties.task.enum - schemas.GenaiVertexV1beta1VideoConfig.properties.task.enumDescriptions - schemas.GenaiVertexV1beta1VideoConfig.properties.task.type - schemas.GenaiVertexV1beta1VideoConfig.type - schemas.GenaiVertexV1beta1VideoContent.properties.mimeType.description - schemas.GenaiVertexV1beta1VideoContent.properties.mimeType.enum - schemas.GenaiVertexV1beta1VideoContent.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1VideoContent.properties.mimeType.type - schemas.GenaiVertexV1beta1VideoDelta.properties.mimeType.enum - schemas.GenaiVertexV1beta1VideoDelta.properties.mimeType.enumDescriptions - schemas.GenaiVertexV1beta1VideoDelta.properties.mimeType.type - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.aspectRatio.description - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.aspectRatio.enum - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.aspectRatio.type - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.delivery.description - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.delivery.enum - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.delivery.enumDescriptions - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.delivery.type - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.duration.description - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.duration.format - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.duration.type - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.gcsUri.description - schemas.GenaiVertexV1beta1VideoResponseFormat.properties.gcsUri.type - schemas.GenaiVertexV1beta1WordInfo.description - schemas.GenaiVertexV1beta1WordInfo.id - schemas.GenaiVertexV1beta1WordInfo.properties.endOffset.description - schemas.GenaiVertexV1beta1WordInfo.properties.endOffset.format - schemas.GenaiVertexV1beta1WordInfo.properties.endOffset.type - schemas.GenaiVertexV1beta1WordInfo.properties.speaker.description - schemas.GenaiVertexV1beta1WordInfo.properties.speaker.type - schemas.GenaiVertexV1beta1WordInfo.properties.startOffset.description - schemas.GenaiVertexV1beta1WordInfo.properties.startOffset.format - schemas.GenaiVertexV1beta1WordInfo.properties.startOffset.type - schemas.GenaiVertexV1beta1WordInfo.properties.text.description - schemas.GenaiVertexV1beta1WordInfo.properties.text.type - schemas.GenaiVertexV1beta1WordInfo.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.id - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.data.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.data.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.data.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.data.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.filename.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.filename.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.mediaType.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.mediaType.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.metadata.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.raw.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.raw.format - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.raw.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.text.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.text.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.url.description - schemas.GoogleCloudAiplatformV1beta1A2aPart.properties.url.type - schemas.GoogleCloudAiplatformV1beta1A2aPart.type - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.appId.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.appId.type - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.artifacts.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.artifacts.items.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.artifacts.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.artifacts.type - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.generation.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.generation.format - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.generation.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.generation.type - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.history.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.history.items.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.history.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.history.type - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.status.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.status.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.status.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.userId.description - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.userId.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.artifactId.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.artifactId.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.description.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.description.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.extensions.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.extensions.items.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.extensions.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.metadata.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.parts.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.parts.items.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.properties.parts.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifact.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.append.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.append.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.artifact.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.artifact.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.lastChunk.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.properties.lastChunk.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskArtifactChange.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.eventData.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.eventData.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.generation.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.generation.format - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.generation.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.generation.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.metadata.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEvent.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.artifactChange.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.artifactChange.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.historyAppend.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.historyAppend.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.metadataChange.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.metadataChange.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.statusUpdate.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.properties.statusUpdate.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskEventData.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend.properties.message.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend.properties.message.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.extensions.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.extensions.items.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.extensions.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.messageId.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.messageId.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.metadata.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.parts.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.parts.items.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.parts.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.referenceTaskIds.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.referenceTaskIds.items.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.referenceTaskIds.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.role.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.role.enum - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.role.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.properties.role.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMessage.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.metadata.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.updateMask.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.updateMask.format - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.properties.updateMask.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskMetadataChange.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.message.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.message.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.message.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.state.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.state.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.state.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.timestamp.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.timestamp.format - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.timestamp.readOnly - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.properties.timestamp.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatus.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.id - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.message.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.message.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.state.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.state.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.timestamp.description - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.timestamp.format - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.properties.timestamp.type - schemas.GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.id - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.logBuckets.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.logBuckets.items.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.logBuckets.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.name.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.name.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.observabilityBuckets.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.observabilityBuckets.items.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.observabilityBuckets.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state.description - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state.readOnly - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.properties.state.type - schemas.GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope.type - schemas.GoogleCloudAiplatformV1beta1AgentResource.description - schemas.GoogleCloudAiplatformV1beta1AgentResource.id - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agent.description - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agent.type - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentFramework.description - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentFramework.enum - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentFramework.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentFramework.type - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentType.description - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentType.enum - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.agentType.type - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.location.description - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.location.readOnly - schemas.GoogleCloudAiplatformV1beta1AgentResource.properties.location.type - schemas.GoogleCloudAiplatformV1beta1AgentResource.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.id - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.agentAggregates.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.agentAggregates.items.$ref - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.agentAggregates.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.summary.$ref - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.properties.summary.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.id - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentDisplayName.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentDisplayName.readOnly - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentDisplayName.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentResourceName.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentResourceName.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentStatus.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentStatus.enum - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentStatus.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentStatus.readOnly - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.agentStatus.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.anomalousSessionsCount.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.anomalousSessionsCount.format - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.anomalousSessionsCount.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.latestSessionTime.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.latestSessionTime.format - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.latestSessionTime.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.location.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.location.readOnly - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.location.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.monitoredAgent.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.monitoredAgent.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.severities.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.severities.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.severities.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.totalSessionsCount.description - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.totalSessionsCount.format - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.properties.totalSessionsCount.type - schemas.GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.id - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.assessment.$ref - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.assessment.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.assessment.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationId.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationId.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationId.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationState.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationState.enum - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationState.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationState.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.invocationState.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.name.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.properties.name.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedInvocation.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.id - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentDisplayName.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentDisplayName.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentDisplayName.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentResourceName.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentResourceName.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentResourceName.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentState.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentState.enum - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentState.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentState.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.agentState.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.assessment.$ref - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.assessment.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.assessment.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.latestAnalyzedTime.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.latestAnalyzedTime.format - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.latestAnalyzedTime.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.latestAnalyzedTime.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.location.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.location.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.location.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.name.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.name.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionId.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionId.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionId.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionState.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionState.enum - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionState.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionState.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.sessionState.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.severities.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.severities.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.severities.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.severities.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.userId.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.userId.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.properties.userId.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSession.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.id - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.detectorIds.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.detectorIds.items.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.detectorIds.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.sessionsCount.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.sessionsCount.format - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.sessionsCount.readOnly - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.sessionsCount.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.severityLevel.description - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.severityLevel.enum - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.severityLevel.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.properties.severityLevel.type - schemas.GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary.type - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.events.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.events.items.$ref - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.events.type - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.generation.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.generation.format - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.generation.type - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse.properties.generation.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse.properties.generation.format - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse.properties.generation.type - schemas.GoogleCloudAiplatformV1beta1Assessment.description - schemas.GoogleCloudAiplatformV1beta1Assessment.id - schemas.GoogleCloudAiplatformV1beta1Assessment.properties.detectorFindings.description - schemas.GoogleCloudAiplatformV1beta1Assessment.properties.detectorFindings.items.$ref - schemas.GoogleCloudAiplatformV1beta1Assessment.properties.detectorFindings.type - schemas.GoogleCloudAiplatformV1beta1Assessment.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.id - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.detectorId.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.detectorId.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.explanation.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.explanation.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.probability.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.probability.format - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.probability.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.recommendations.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.recommendations.items.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.recommendations.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.severity.description - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.severity.enum - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.severity.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.properties.severity.type - schemas.GoogleCloudAiplatformV1beta1AssessmentDetectorFinding.type - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.description - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.id - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.bitRate.description - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.bitRate.format - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.bitRate.type - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.sampleRate.description - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.sampleRate.format - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.properties.sampleRate.type - schemas.GoogleCloudAiplatformV1beta1AudioResponseFormat.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.id - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.speakerLabel.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.speakerLabel.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.text.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.text.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.words.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.words.items.$ref - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.properties.words.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscription.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.id - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.adaptationPhrases.deprecated - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.adaptationPhrases.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.adaptationPhrases.items.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.adaptationPhrases.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.customVocabulary.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.customVocabulary.items.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.customVocabulary.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.diarization.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.diarization.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.languageAuto.$ref - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.languageAuto.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.languageHints.$ref - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.languageHints.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.wordTimestamp.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.properties.wordTimestamp.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfig.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto.id - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.id - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.properties.languageCodes.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.properties.languageCodes.items.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.properties.languageCodes.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.id - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.endOffset.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.endOffset.format - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.endOffset.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.startOffset.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.startOffset.format - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.startOffset.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.word.description - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.properties.word.type - schemas.GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo.type - schemas.GoogleCloudAiplatformV1beta1BatchPredictionJob.properties.endpoint.description - schemas.GoogleCloudAiplatformV1beta1BatchPredictionJob.properties.endpoint.type - schemas.GoogleCloudAiplatformV1beta1CandidateResult.properties.error.$ref - schemas.GoogleCloudAiplatformV1beta1CandidateResult.properties.error.description - schemas.GoogleCloudAiplatformV1beta1CandidateResult.properties.error.readOnly - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.id - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.project.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.project.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.resourceLabels.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.resourceLabels.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.resourceLabels.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.resourceType.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.resourceType.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.tracingContext.$ref - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.properties.tracingContext.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfig.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.id - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.conversationId.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.conversationId.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.spanId.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.spanId.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.traceId.description - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.properties.traceId.type - schemas.GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext.type - schemas.GoogleCloudAiplatformV1beta1CodeExecutionResult.properties.id.description - schemas.GoogleCloudAiplatformV1beta1CodeExecutionResult.properties.id.type - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.id - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.properties.weightedRewardConfigs.description - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.properties.weightedRewardConfigs.items.$ref - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.properties.weightedRewardConfigs.type - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig.type - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.id - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.properties.rewardConfig.$ref - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.properties.rewardConfig.description - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.properties.weight.description - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.properties.weight.format - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.properties.weight.type - schemas.GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig.type - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.contentsPerExampleDistribution.$ref - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.contentsPerExampleDistribution.description - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.contentsPerExampleDistribution.readOnly - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.reinforcementTuningUserDatasetExamples.$ref - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.reinforcementTuningUserDatasetExamples.description - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.reinforcementTuningUserDatasetExamples.readOnly - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.totalBillableTokenCount.description - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.totalBillableTokenCount.format - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.totalBillableTokenCount.readOnly - schemas.GoogleCloudAiplatformV1beta1DatasetStats.properties.totalBillableTokenCount.type - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.description - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.id - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.description - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.type - schemas.GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest.type - schemas.GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest.description - schemas.GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest.id - schemas.GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest.type - schemas.GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest.description - schemas.GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest.id - schemas.GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest.type - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.publisherModelConfig.$ref - schemas.GoogleCloudAiplatformV1beta1Endpoint.properties.publisherModelConfig.description - schemas.GoogleCloudAiplatformV1beta1EvaluationMetric.properties.encryptionSpec.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationMetric.properties.encryptionSpec.description - schemas.GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.description - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.promptTemplate.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig.properties.promptTemplate.description - schemas.GoogleCloudAiplatformV1beta1EvaluationSet.properties.encryptionSpec.$ref - schemas.GoogleCloudAiplatformV1beta1EvaluationSet.properties.encryptionSpec.description - schemas.GoogleCloudAiplatformV1beta1ExecutableCode.properties.id.description - schemas.GoogleCloudAiplatformV1beta1ExecutableCode.properties.id.type - schemas.GoogleCloudAiplatformV1beta1ExpressProject.properties.tier.description - schemas.GoogleCloudAiplatformV1beta1ExpressProject.properties.tier.enum - schemas.GoogleCloudAiplatformV1beta1ExpressProject.properties.tier.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ExpressProject.properties.tier.readOnly - schemas.GoogleCloudAiplatformV1beta1ExpressProject.properties.tier.type - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.description - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.id - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.properties.contextEvents.description - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.properties.contextEvents.items.$ref - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.properties.contextEvents.type - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.properties.name.description - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.properties.name.type - schemas.GoogleCloudAiplatformV1beta1FeedbackContext.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.id - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.customMetadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.customMetadata.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.customMetadata.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.eventId.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.eventId.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackLabels.items.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackLabels.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackText.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackText.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackType.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackType.enum - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.feedbackType.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.name.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.name.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.sessionId.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.sessionId.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.source.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.source.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.updateTime.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.updateTime.format - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.updateTime.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.userId.description - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.properties.userId.type - schemas.GoogleCloudAiplatformV1beta1FeedbackEntry.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.id - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.allowedProjects.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.allowedProjects.items.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.allowedProjects.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.dnsRecord.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.dnsRecord.readOnly - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.dnsRecord.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.dnsZoneName.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.dnsZoneName.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.ipAddress.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.ipAddress.readOnly - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.ipAddress.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.network.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.network.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.pscEndpoint.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.pscEndpoint.readOnly - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.pscEndpoint.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.state.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.state.readOnly - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.state.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.subnetwork.description - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.properties.subnetwork.type - schemas.GoogleCloudAiplatformV1beta1GatewayConfig.type - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.audioTranscriptionConfig.$ref - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.audioTranscriptionConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.imageConfig.deprecated - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseFormat.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseFormat.items.$ref - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseFormat.type - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseJsonSchema.deprecated - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseMimeType.deprecated - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseSchema.deprecated - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.enableWidget.deprecated - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.groundingTypes.$ref - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.groundingTypes.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.id - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.properties.places.$ref - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.properties.places.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.properties.routing.$ref - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.properties.routing.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes.type - schemas.GoogleCloudAiplatformV1beta1GoogleMapsPlaces.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsPlaces.id - schemas.GoogleCloudAiplatformV1beta1GoogleMapsPlaces.type - schemas.GoogleCloudAiplatformV1beta1GoogleMapsRouting.description - schemas.GoogleCloudAiplatformV1beta1GoogleMapsRouting.id - schemas.GoogleCloudAiplatformV1beta1GoogleMapsRouting.type - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.googleMapsWidgetContextToken.deprecated - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.description - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.id - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.aspectRatio.description - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.aspectRatio.enum - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.aspectRatio.type - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.imageSize.description - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.imageSize.enum - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.imageSize.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.imageSize.type - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1beta1ImageResponseFormat.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.agentEngineSource.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.agentEngineSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.bigquerySource.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.bigquerySource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.cloudTraceSource.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.cloudTraceSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.evaluationSet.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.evaluationSet.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.gcsDestination.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.gcsDestination.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.gcsSource.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.gcsSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.inlineSource.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.properties.inlineSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.location.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.location.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.projectId.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.projectId.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.reasoningEngineId.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.reasoningEngineId.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.items.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.projectId.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.projectId.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.items.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.items.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.properties.importSchemaConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.properties.importSchemaConfig.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.enum - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormatVersion.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormatVersion.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.id - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.properties.content.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.properties.content.format - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.properties.content.type - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.properties.importSchemaConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.properties.importSchemaConfig.description - schemas.GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource.type - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.description - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.id - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.properties.state.description - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.properties.state.type - schemas.GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.disableMemoryRevisions.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.disableMemoryRevisions.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadata.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadata.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadataMergeStrategy.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadataMergeStrategy.enum - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadataMergeStrategy.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.metadataMergeStrategy.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionExpireTime.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionExpireTime.format - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionExpireTime.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionLabels.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionLabels.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionLabels.type - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionTtl.description - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionTtl.format - schemas.GoogleCloudAiplatformV1beta1IngestEventsRequest.properties.revisionTtl.type - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.properties.events.description - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.properties.events.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.properties.events.type - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.description - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.id - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.properties.agentAnomalyDetectionScopes.description - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.properties.agentAnomalyDetectionScopes.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.properties.agentAnomalyDetectionScopes.type - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.id - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.properties.analyzedInvocations.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.properties.analyzedInvocations.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.properties.analyzedInvocations.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.id - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.analyzedSessions.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.analyzedSessions.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.analyzedSessions.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.summary.$ref - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.properties.summary.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.id - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousAgentsCount.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousAgentsCount.format - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousAgentsCount.readOnly - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousAgentsCount.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousSessionsCount.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousSessionsCount.format - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.anomalousSessionsCount.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.llmScannedSessionsCount.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.llmScannedSessionsCount.format - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.llmScannedSessionsCount.readOnly - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.llmScannedSessionsCount.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.severities.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.severities.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.severities.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.totalSessionsCount.description - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.totalSessionsCount.format - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.properties.totalSessionsCount.type - schemas.GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary.type - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.description - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.id - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.properties.feedbackEntries.description - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.properties.feedbackEntries.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.properties.feedbackEntries.type - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse.type - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.description - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.id - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.monitoredAgents.description - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.monitoredAgents.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.monitoredAgents.type - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.totalSize.description - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.totalSize.format - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.properties.totalSize.type - schemas.GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse.type - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.description - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.id - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.description - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.type - schemas.GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse.type - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.description - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.id - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.nextPageToken.readOnly - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.servingProfiles.description - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.servingProfiles.items.$ref - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.servingProfiles.readOnly - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.properties.servingProfiles.type - schemas.GoogleCloudAiplatformV1beta1ListServingProfilesResponse.type - schemas.GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.description - schemas.GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.format - schemas.GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.id - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.agentResource.$ref - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.agentResource.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.name.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.name.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.state.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.state.readOnly - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.state.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.statusMessage.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.statusMessage.readOnly - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.statusMessage.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.updateTime.description - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.updateTime.format - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.properties.updateTime.type - schemas.GoogleCloudAiplatformV1beta1MonitoredAgent.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.id - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableIntegrityMonitoring.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableIntegrityMonitoring.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableSecureBoot.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableSecureBoot.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableVtpm.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableVtpm.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.$ref - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.id - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.repository.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.repository.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.tag.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.tag.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.id - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.family.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.family.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.name.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.name.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.project.description - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.project.type - schemas.GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage.type - schemas.GoogleCloudAiplatformV1beta1Part.properties.audioTranscription.$ref - schemas.GoogleCloudAiplatformV1beta1Part.properties.audioTranscription.description - schemas.GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest.description - schemas.GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest.id - schemas.GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest.type - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.id - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.gcsDestination.$ref - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.gcsDestination.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.gcsSource.$ref - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.gcsSource.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.inputBucketProjectNumber.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.inputBucketProjectNumber.format - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.inputBucketProjectNumber.type - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.outputBucketProjectNumber.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.outputBucketProjectNumber.format - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.outputBucketProjectNumber.type - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.veoSpec.$ref - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.properties.veoSpec.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequest.type - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.id - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.properties.processType.description - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.properties.processType.enum - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.properties.processType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.properties.processType.type - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.type - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.claudeFeatureConfig.$ref - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.claudeFeatureConfig.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.dataSharingEnabledProvider.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.dataSharingEnabledProvider.enum - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.dataSharingEnabledProvider.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.dataSharingEnabledProvider.type - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.inferenceEventLoggingConfig.$ref - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.inferenceEventLoggingConfig.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.id - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.properties.advancedAiEnabled.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.properties.advancedAiEnabled.type - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.properties.cyberVerificationProgramEnabled.deprecated - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.properties.cyberVerificationProgramEnabled.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.properties.cyberVerificationProgramEnabled.type - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.buildSpec.$ref - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpec.properties.buildSpec.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.id - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.properties.serviceAccount.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.properties.serviceAccount.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.properties.workerPool.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.properties.workerPool.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec.type - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec.properties.port.description - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec.properties.port.format - schemas.GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec.properties.port.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterPrompt.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterPrompt.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterResponseParseConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.autoraterResponseParseConfig.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.exactMatchScorer.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.exactMatchScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.parsedResponseConversionScorer.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.properties.parsedResponseConversionScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.correctAnswerReward.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.correctAnswerReward.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.correctAnswerReward.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.expression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.expression.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.wrongAnswerReward.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.wrongAnswerReward.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.properties.wrongAnswerReward.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer.properties.cloudRunUri.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer.properties.cloudRunUri.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer.properties.pythonCodeSnippet.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer.properties.pythonCodeSnippet.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.contents.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.contents.items.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.contents.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.references.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.references.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.references.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.systemInstruction.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.properties.systemInstruction.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningExample.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.adapterSize.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.adapterSize.enum - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.adapterSize.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.adapterSize.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.batchSize.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.batchSize.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.batchSize.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.checkpointInterval.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.checkpointInterval.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.checkpointInterval.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.epochCount.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.epochCount.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.epochCount.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.evaluateInterval.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.evaluateInterval.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.evaluateInterval.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.learningRateMultiplier.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.learningRateMultiplier.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.learningRateMultiplier.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.maxOutputTokens.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.maxOutputTokens.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.maxOutputTokens.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.samplesPerPrompt.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.samplesPerPrompt.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.samplesPerPrompt.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.stepCount.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.stepCount.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.stepCount.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingBudget.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingBudget.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingBudget.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingLevel.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingLevel.enum - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingLevel.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.properties.thinkingLevel.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.parseType.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.parseType.enum - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.parseType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.parseType.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.regexExtractExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.properties.regexExtractExpression.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.reward.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.reward.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.reward.readOnly - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.reward.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.userRequestedAuxInfo.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.userRequestedAuxInfo.readOnly - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.properties.userRequestedAuxInfo.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.compositeRewardConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.compositeRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.hyperParameters.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.hyperParameters.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.singleRewardConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.singleRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.trainingDatasetUri.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.trainingDatasetUri.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.validationDatasetUri.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.properties.validationDatasetUri.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningSpec.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.correctAnswerReward.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.correctAnswerReward.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.correctAnswerReward.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.jsonMatchExpression.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.jsonMatchExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.stringMatchExpression.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.stringMatchExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.wrongAnswerReward.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.wrongAnswerReward.format - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.properties.wrongAnswerReward.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.properties.keyName.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.properties.keyName.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.properties.valueStringMatchExpression.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.properties.valueStringMatchExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.expression.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.expression.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.matchOperation.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.matchOperation.enum - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.matchOperation.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.properties.matchOperation.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.id - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.properties.userDatasetExamples.description - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.properties.userDatasetExamples.items.$ref - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.properties.userDatasetExamples.type - schemas.GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples.type - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.description - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.id - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.audio.$ref - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.audio.description - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.image.$ref - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.image.description - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.text.$ref - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.text.description - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.video.$ref - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.properties.video.description - schemas.GoogleCloudAiplatformV1beta1ResponseFormat.type - schemas.GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest.description - schemas.GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest.id - schemas.GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.resources.$ref - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.resources.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.items.$ref - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.id - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.domain.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.domain.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetNetwork.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetNetwork.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetProject.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetProject.type - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.id - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.agent.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.agent.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.agentIdentity.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.agentIdentity.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.agentIdentity.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.description.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.description.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.etag.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.etag.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.mcpTools.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.mcpTools.items.$ref - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.mcpTools.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.name.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.name.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.naturalLanguageConstraint.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.naturalLanguageConstraint.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.updateTime.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.updateTime.format - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.updateTime.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.id - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.gatewayConfigs.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.gatewayConfigs.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.gatewayConfigs.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.ipAddress.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.ipAddress.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.ipAddress.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.name.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.name.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscForwardingRule.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscForwardingRule.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscForwardingRule.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.state.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.state.enum - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.state.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.state.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.updateTime.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.updateTime.format - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.properties.updateTime.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.id - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.properties.mcpServer.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.properties.mcpServer.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.properties.tools.description - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.properties.tools.items.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.properties.tools.type - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.id - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.cmekConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.cmekConfig.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.createTime.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.createTime.format - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.createTime.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.description.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.description.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.displayName.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.name.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.name.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.scope.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.scope.enum - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.scope.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.scope.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.updateTime.description - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.updateTime.format - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1beta1ServingProfile.properties.updateTime.type - schemas.GoogleCloudAiplatformV1beta1ServingProfile.type - schemas.GoogleCloudAiplatformV1beta1ServingProfileCmekConfig.description - schemas.GoogleCloudAiplatformV1beta1ServingProfileCmekConfig.id - schemas.GoogleCloudAiplatformV1beta1ServingProfileCmekConfig.properties.encryptionSpec.$ref - schemas.GoogleCloudAiplatformV1beta1ServingProfileCmekConfig.properties.encryptionSpec.description - schemas.GoogleCloudAiplatformV1beta1ServingProfileCmekConfig.type - schemas.GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest.properties.updateMask.description - schemas.GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest.properties.updateMask.format - schemas.GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest.properties.updateMask.type - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.id - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.autoraterScorer.$ref - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.autoraterScorer.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.cloudRunRewardScorer.$ref - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.cloudRunRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.codeExecutionRewardScorer.$ref - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.codeExecutionRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.parseResponseConfig.$ref - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.parseResponseConfig.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.rewardName.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.rewardName.type - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.stringMatchRewardScorer.$ref - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.properties.stringMatchRewardScorer.description - schemas.GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig.type - schemas.GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig.properties.jsonSchema.description - schemas.GoogleCloudAiplatformV1beta1StructuredMemoryConfigSchemaConfig.properties.jsonSchema.type - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.description - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.id - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.schema.description - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.properties.schema.type - schemas.GoogleCloudAiplatformV1beta1TextResponseFormat.type - schemas.GoogleCloudAiplatformV1beta1Tool.properties.exaAiSearch.$ref - schemas.GoogleCloudAiplatformV1beta1Tool.properties.exaAiSearch.description - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse.properties.enablePromptInjectionDetection.description - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse.properties.enablePromptInjectionDetection.type - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.description - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.id - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.apiKey.description - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.apiKey.type - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.customConfigs.additionalProperties.description - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.customConfigs.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.customConfigs.description - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.properties.customConfigs.type - schemas.GoogleCloudAiplatformV1beta1ToolExaAiSearch.type - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableDataRetention.deprecated - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableDataRetention.description - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableDataRetention.type - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableZeroDataRetention.description - schemas.GoogleCloudAiplatformV1beta1ToolParallelAiSearch.properties.enableZeroDataRetention.type - schemas.GoogleCloudAiplatformV1beta1TuningDataStats.properties.reinforcementTuningDataStats.$ref - schemas.GoogleCloudAiplatformV1beta1TuningDataStats.properties.reinforcementTuningDataStats.description - schemas.GoogleCloudAiplatformV1beta1TuningDataStats.properties.reinforcementTuningDataStats.readOnly - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.reinforcementTuningSpec.$ref - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.reinforcementTuningSpec.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.id - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.compositeRewardConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.compositeRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.example.$ref - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.example.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.sampleResponse.$ref - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.sampleResponse.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.singleRewardConfig.$ref - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.properties.singleRewardConfig.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.id - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.error.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.error.readOnly - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.error.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.overallReward.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.overallReward.format - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.overallReward.readOnly - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.overallReward.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.additionalProperties.format - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.additionalProperties.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.deprecated - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.readOnly - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardDetails.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardInfoDetails.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardInfoDetails.description - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.properties.rewardInfoDetails.type - schemas.GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse.type - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.description - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.id - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.aspectRatio.description - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.aspectRatio.enum - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.aspectRatio.type - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.duration.description - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.duration.format - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.duration.type - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1beta1VideoResponseFormat.type The following keys were changed: - resources.projects.resources.locations.resources.agents.methods.create.description - resources.projects.resources.locations.resources.agents.methods.delete.description - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.get.description - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.list.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agents.methods.patch.description - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.appendEvents.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.create.parameters.a2aTaskId.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.get.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.resources.events.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.reasoningEngines.resources.a2aTasks.resources.events.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.skills.methods.create.parameters.skillId.description - resources.reasoningEngines.resources.memories.methods.patch.parameters.updateMask.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.codec.enum - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.codec.enumDescriptions - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.delivery.enum - schemas.GenaiVertexV1beta1AudioResponseFormat.properties.delivery.enumDescriptions - schemas.GenaiVertexV1beta1ComputerUse.properties.environment.enum - schemas.GenaiVertexV1beta1ComputerUse.properties.environment.enumDescriptions - schemas.GenaiVertexV1beta1DynamicAgentConfig.properties.config.$ref - schemas.GenaiVertexV1beta1Function.properties.parameters.$ref - schemas.GenaiVertexV1beta1FunctionCallContent.properties.arguments.$ref - schemas.GenaiVertexV1beta1FunctionCallDelta.properties.arguments.$ref - schemas.GenaiVertexV1beta1FunctionCallStep.properties.arguments.$ref - schemas.GenaiVertexV1beta1FunctionResultContent.properties.structResult.$ref - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.delivery.enum - schemas.GenaiVertexV1beta1ImageResponseFormat.properties.delivery.enumDescriptions - schemas.GenaiVertexV1beta1Interaction.properties.status.enum - schemas.GenaiVertexV1beta1Interaction.properties.status.enumDescriptions - schemas.GenaiVertexV1beta1Interaction.properties.steps.description - schemas.GenaiVertexV1beta1InteractionStatusUpdate.properties.status.enum - schemas.GenaiVertexV1beta1InteractionStatusUpdate.properties.status.enumDescriptions - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentDelta.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentStart.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.contentStop.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionCompleteEvent.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionCompletedEvent.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionCreatedEvent.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.interactionStartEvent.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.stepDelta.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.stepStart.description - schemas.GenaiVertexV1beta1InteractionStreamingEvent.properties.stepStop.description - schemas.GenaiVertexV1beta1McpServerToolCallContent.properties.arguments.$ref - schemas.GenaiVertexV1beta1McpServerToolCallDelta.properties.arguments.$ref - schemas.GenaiVertexV1beta1McpServerToolCallStep.properties.arguments.$ref - schemas.GenaiVertexV1beta1McpServerToolResultContent.properties.structResult.$ref - schemas.GenaiVertexV1beta1ResponseFormat.properties.structValue.$ref - schemas.GenaiVertexV1beta1TextResponseFormat.properties.schema.$ref - schemas.GenaiVertexV1beta1ThoughtStep.properties.summary.items.$ref - schemas.GenaiVertexV1beta1ThoughtSummaryDelta.properties.content.$ref - schemas.GoogleCloudAiplatformV1beta1A2aTask.properties.name.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.base_agent.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.base_environment.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.created.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.id.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.metadata.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.name.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.object.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.system_instruction.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.tools.description - schemas.GoogleCloudAiplatformV1beta1Agent.properties.updated.description - schemas.GoogleCloudAiplatformV1beta1AgentTool.description - schemas.GoogleCloudAiplatformV1beta1AgentTool.properties.headers.description - schemas.GoogleCloudAiplatformV1beta1AgentTool.properties.name.description - schemas.GoogleCloudAiplatformV1beta1AgentTool.properties.type.description - schemas.GoogleCloudAiplatformV1beta1AgentTool.properties.url.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest.properties.taskEvents.description - schemas.GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse.description - schemas.GoogleCloudAiplatformV1beta1AutomaticResources.description - schemas.GoogleCloudAiplatformV1beta1AutomaticResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1BatchDedicatedResources.properties.startingReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1DedicatedResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1beta1EvaluateInstancesRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest.properties.agents.description - schemas.GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest.properties.rootAgentId.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.imageConfig.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseJsonSchema.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseMimeType.description - schemas.GoogleCloudAiplatformV1beta1GenerationConfig.properties.responseSchema.description - schemas.GoogleCloudAiplatformV1beta1GoogleMaps.properties.enableWidget.description - schemas.GoogleCloudAiplatformV1beta1GroundingMetadata.properties.googleMapsWidgetContextToken.description - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.description - schemas.GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse.properties.taskEvents.description - schemas.GoogleCloudAiplatformV1beta1ListA2aTasksResponse.description - schemas.GoogleCloudAiplatformV1beta1ListAgentsResponse.properties.agents.description - schemas.GoogleCloudAiplatformV1beta1ListAgentsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.acceleratorCount.description - schemas.GoogleCloudAiplatformV1beta1MachineSpec.properties.machineType.description - schemas.GoogleCloudAiplatformV1beta1Model.properties.containerSpec.description - schemas.GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError.properties.errorType.enum - schemas.GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadataRecordError.properties.errorType.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluator.properties.cloudObservability.description - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluator.properties.displayName.description - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability.description - schemas.GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityTraceScopePredicate.properties.duration.description - schemas.GoogleCloudAiplatformV1beta1PersistentDiskSpec.description - schemas.GoogleCloudAiplatformV1beta1PersistentDiskSpec.properties.diskType.description - schemas.GoogleCloudAiplatformV1beta1PublisherModelConfig.properties.loggingConfig.description - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.defaultContainerCategory.enum - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.defaultContainerCategory.enumDescriptions - schemas.GoogleCloudAiplatformV1beta1SkillRevision.properties.skill.description - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse.properties.environment.enum - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse.properties.environment.enumDescriptions #### aiplatform:v1 The following keys were added: - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.description - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.id - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.path - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.cancel.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.delete.description - resources.memoryBanks.resources.memories.resources.operations.methods.delete.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.delete.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.delete.id - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.delete.path - resources.memoryBanks.resources.memories.resources.operations.methods.delete.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.delete.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.get.description - resources.memoryBanks.resources.memories.resources.operations.methods.get.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.get.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.get.id - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.get.path - resources.memoryBanks.resources.memories.resources.operations.methods.get.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.get.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.list.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.list.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.list.id - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.memoryBanks.resources.memories.resources.operations.methods.list.path - resources.memoryBanks.resources.memories.resources.operations.methods.list.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.list.scopes - resources.memoryBanks.resources.memories.resources.operations.methods.wait.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.flatPath - resources.memoryBanks.resources.memories.resources.operations.methods.wait.httpMethod - resources.memoryBanks.resources.memories.resources.operations.methods.wait.id - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameterOrder - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.location - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.pattern - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.required - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.type - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.description - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.format - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.location - resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.type - resources.memoryBanks.resources.memories.resources.operations.methods.wait.path - resources.memoryBanks.resources.memories.resources.operations.methods.wait.response.$ref - resources.memoryBanks.resources.memories.resources.operations.methods.wait.scopes - resources.memoryBanks.resources.operations.methods.cancel.description - resources.memoryBanks.resources.operations.methods.cancel.flatPath - resources.memoryBanks.resources.operations.methods.cancel.httpMethod - resources.memoryBanks.resources.operations.methods.cancel.id - resources.memoryBanks.resources.operations.methods.cancel.parameterOrder - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.description - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.location - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.required - resources.memoryBanks.resources.operations.methods.cancel.parameters.name.type - resources.memoryBanks.resources.operations.methods.cancel.path - resources.memoryBanks.resources.operations.methods.cancel.response.$ref - resources.memoryBanks.resources.operations.methods.cancel.scopes - resources.memoryBanks.resources.operations.methods.delete.description - resources.memoryBanks.resources.operations.methods.delete.flatPath - resources.memoryBanks.resources.operations.methods.delete.httpMethod - resources.memoryBanks.resources.operations.methods.delete.id - resources.memoryBanks.resources.operations.methods.delete.parameterOrder - resources.memoryBanks.resources.operations.methods.delete.parameters.name.description - resources.memoryBanks.resources.operations.methods.delete.parameters.name.location - resources.memoryBanks.resources.operations.methods.delete.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.delete.parameters.name.required - resources.memoryBanks.resources.operations.methods.delete.parameters.name.type - resources.memoryBanks.resources.operations.methods.delete.path - resources.memoryBanks.resources.operations.methods.delete.response.$ref - resources.memoryBanks.resources.operations.methods.delete.scopes - resources.memoryBanks.resources.operations.methods.get.description - resources.memoryBanks.resources.operations.methods.get.flatPath - resources.memoryBanks.resources.operations.methods.get.httpMethod - resources.memoryBanks.resources.operations.methods.get.id - resources.memoryBanks.resources.operations.methods.get.parameterOrder - resources.memoryBanks.resources.operations.methods.get.parameters.name.description - resources.memoryBanks.resources.operations.methods.get.parameters.name.location - resources.memoryBanks.resources.operations.methods.get.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.get.parameters.name.required - resources.memoryBanks.resources.operations.methods.get.parameters.name.type - resources.memoryBanks.resources.operations.methods.get.path - resources.memoryBanks.resources.operations.methods.get.response.$ref - resources.memoryBanks.resources.operations.methods.get.scopes - resources.memoryBanks.resources.operations.methods.list.description - resources.memoryBanks.resources.operations.methods.list.flatPath - resources.memoryBanks.resources.operations.methods.list.httpMethod - resources.memoryBanks.resources.operations.methods.list.id - resources.memoryBanks.resources.operations.methods.list.parameterOrder - resources.memoryBanks.resources.operations.methods.list.parameters.filter.description - resources.memoryBanks.resources.operations.methods.list.parameters.filter.location - resources.memoryBanks.resources.operations.methods.list.parameters.filter.type - resources.memoryBanks.resources.operations.methods.list.parameters.name.description - resources.memoryBanks.resources.operations.methods.list.parameters.name.location - resources.memoryBanks.resources.operations.methods.list.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.list.parameters.name.required - resources.memoryBanks.resources.operations.methods.list.parameters.name.type - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.description - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.format - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.location - resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.type - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.description - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.location - resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.type - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.memoryBanks.resources.operations.methods.list.path - resources.memoryBanks.resources.operations.methods.list.response.$ref - resources.memoryBanks.resources.operations.methods.list.scopes - resources.memoryBanks.resources.operations.methods.wait.description - resources.memoryBanks.resources.operations.methods.wait.flatPath - resources.memoryBanks.resources.operations.methods.wait.httpMethod - resources.memoryBanks.resources.operations.methods.wait.id - resources.memoryBanks.resources.operations.methods.wait.parameterOrder - resources.memoryBanks.resources.operations.methods.wait.parameters.name.description - resources.memoryBanks.resources.operations.methods.wait.parameters.name.location - resources.memoryBanks.resources.operations.methods.wait.parameters.name.pattern - resources.memoryBanks.resources.operations.methods.wait.parameters.name.required - resources.memoryBanks.resources.operations.methods.wait.parameters.name.type - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.description - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.format - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.location - resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.type - resources.memoryBanks.resources.operations.methods.wait.path - resources.memoryBanks.resources.operations.methods.wait.response.$ref - resources.memoryBanks.resources.operations.methods.wait.scopes - resources.onlineEvaluators.resources.operations.methods.cancel.description - resources.onlineEvaluators.resources.operations.methods.cancel.flatPath - resources.onlineEvaluators.resources.operations.methods.cancel.httpMethod - resources.onlineEvaluators.resources.operations.methods.cancel.id - resources.onlineEvaluators.resources.operations.methods.cancel.parameterOrder - resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.description - resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.location - resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.pattern - resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.required - resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.type - resources.onlineEvaluators.resources.operations.methods.cancel.path - resources.onlineEvaluators.resources.operations.methods.cancel.response.$ref - resources.onlineEvaluators.resources.operations.methods.cancel.scopes - resources.onlineEvaluators.resources.operations.methods.delete.description - resources.onlineEvaluators.resources.operations.methods.delete.flatPath - resources.onlineEvaluators.resources.operations.methods.delete.httpMethod - resources.onlineEvaluators.resources.operations.methods.delete.id - resources.onlineEvaluators.resources.operations.methods.delete.parameterOrder - resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.description - resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.location - resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.pattern - resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.required - resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.type - resources.onlineEvaluators.resources.operations.methods.delete.path - resources.onlineEvaluators.resources.operations.methods.delete.response.$ref - resources.onlineEvaluators.resources.operations.methods.delete.scopes - resources.onlineEvaluators.resources.operations.methods.get.description - resources.onlineEvaluators.resources.operations.methods.get.flatPath - resources.onlineEvaluators.resources.operations.methods.get.httpMethod - resources.onlineEvaluators.resources.operations.methods.get.id - resources.onlineEvaluators.resources.operations.methods.get.parameterOrder - resources.onlineEvaluators.resources.operations.methods.get.parameters.name.description - resources.onlineEvaluators.resources.operations.methods.get.parameters.name.location - resources.onlineEvaluators.resources.operations.methods.get.parameters.name.pattern - resources.onlineEvaluators.resources.operations.methods.get.parameters.name.required - resources.onlineEvaluators.resources.operations.methods.get.parameters.name.type - resources.onlineEvaluators.resources.operations.methods.get.path - resources.onlineEvaluators.resources.operations.methods.get.response.$ref - resources.onlineEvaluators.resources.operations.methods.get.scopes - resources.onlineEvaluators.resources.operations.methods.list.description - resources.onlineEvaluators.resources.operations.methods.list.flatPath - resources.onlineEvaluators.resources.operations.methods.list.httpMethod - resources.onlineEvaluators.resources.operations.methods.list.id - resources.onlineEvaluators.resources.operations.methods.list.parameterOrder - resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.description - resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.location - resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.type - resources.onlineEvaluators.resources.operations.methods.list.parameters.name.description - resources.onlineEvaluators.resources.operations.methods.list.parameters.name.location - resources.onlineEvaluators.resources.operations.methods.list.parameters.name.pattern - resources.onlineEvaluators.resources.operations.methods.list.parameters.name.required - resources.onlineEvaluators.resources.operations.methods.list.parameters.name.type - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.description - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.format - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.location - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.type - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.description - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.location - resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.type - resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.onlineEvaluators.resources.operations.methods.list.path - resources.onlineEvaluators.resources.operations.methods.list.response.$ref - resources.onlineEvaluators.resources.operations.methods.list.scopes - resources.onlineEvaluators.resources.operations.methods.wait.description - resources.onlineEvaluators.resources.operations.methods.wait.flatPath - resources.onlineEvaluators.resources.operations.methods.wait.httpMethod - resources.onlineEvaluators.resources.operations.methods.wait.id - resources.onlineEvaluators.resources.operations.methods.wait.parameterOrder - resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.description - resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.location - resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.pattern - resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.required - resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.type - resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.description - resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.format - resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.location - resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.type - resources.onlineEvaluators.resources.operations.methods.wait.path - resources.onlineEvaluators.resources.operations.methods.wait.response.$ref - resources.onlineEvaluators.resources.operations.methods.wait.scopes - resources.projects.resources.locations.methods.generateLossClusters.description - resources.projects.resources.locations.methods.generateLossClusters.flatPath - resources.projects.resources.locations.methods.generateLossClusters.httpMethod - resources.projects.resources.locations.methods.generateLossClusters.id - resources.projects.resources.locations.methods.generateLossClusters.parameterOrder - resources.projects.resources.locations.methods.generateLossClusters.parameters.location.description - resources.projects.resources.locations.methods.generateLossClusters.parameters.location.location - resources.projects.resources.locations.methods.generateLossClusters.parameters.location.pattern - resources.projects.resources.locations.methods.generateLossClusters.parameters.location.required - resources.projects.resources.locations.methods.generateLossClusters.parameters.location.type - resources.projects.resources.locations.methods.generateLossClusters.path - resources.projects.resources.locations.methods.generateLossClusters.request.$ref - resources.projects.resources.locations.methods.generateLossClusters.response.$ref - resources.projects.resources.locations.methods.generateLossClusters.scopes - resources.projects.resources.locations.methods.generateUserScenarios.description - resources.projects.resources.locations.methods.generateUserScenarios.flatPath - resources.projects.resources.locations.methods.generateUserScenarios.httpMethod - resources.projects.resources.locations.methods.generateUserScenarios.id - resources.projects.resources.locations.methods.generateUserScenarios.parameterOrder - resources.projects.resources.locations.methods.generateUserScenarios.parameters.location.description - resources.projects.resources.locations.methods.generateUserScenarios.parameters.location.location - resources.projects.resources.locations.methods.generateUserScenarios.parameters.location.pattern - resources.projects.resources.locations.methods.generateUserScenarios.parameters.location.required - resources.projects.resources.locations.methods.generateUserScenarios.parameters.location.type - resources.projects.resources.locations.methods.generateUserScenarios.path - resources.projects.resources.locations.methods.generateUserScenarios.request.$ref - resources.projects.resources.locations.methods.generateUserScenarios.response.$ref - resources.projects.resources.locations.methods.generateUserScenarios.scopes - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.description - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.flatPath - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.httpMethod - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.id - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameterOrder - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.description - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.location - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.pattern - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.required - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.parameters.name.type - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.path - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.response.$ref - resources.projects.resources.locations.methods.getSemanticGovernancePolicyEngine.scopes - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.flatPath - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.httpMethod - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.id - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameterOrder - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.location - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.pattern - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.required - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.name.type - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.description - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.format - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.location - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.parameters.updateMask.type - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.path - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.request.$ref - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.response.$ref - resources.projects.resources.locations.methods.updateSemanticGovernancePolicyEngine.scopes - resources.projects.resources.locations.resources.agents.methods.create.description - resources.projects.resources.locations.resources.agents.methods.create.flatPath - resources.projects.resources.locations.resources.agents.methods.create.httpMethod - resources.projects.resources.locations.resources.agents.methods.create.id - resources.projects.resources.locations.resources.agents.methods.create.parameterOrder - resources.projects.resources.locations.resources.agents.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.agents.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.agents.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.agents.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.agents.methods.create.path - resources.projects.resources.locations.resources.agents.methods.create.request.$ref - resources.projects.resources.locations.resources.agents.methods.create.response.$ref - resources.projects.resources.locations.resources.agents.methods.create.scopes - resources.projects.resources.locations.resources.agents.methods.delete.description - resources.projects.resources.locations.resources.agents.methods.delete.flatPath - resources.projects.resources.locations.resources.agents.methods.delete.httpMethod - resources.projects.resources.locations.resources.agents.methods.delete.id - resources.projects.resources.locations.resources.agents.methods.delete.parameterOrder - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.agents.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.agents.methods.delete.path - resources.projects.resources.locations.resources.agents.methods.delete.response.$ref - resources.projects.resources.locations.resources.agents.methods.delete.scopes - resources.projects.resources.locations.resources.agents.methods.get.description - resources.projects.resources.locations.resources.agents.methods.get.flatPath - resources.projects.resources.locations.resources.agents.methods.get.httpMethod - resources.projects.resources.locations.resources.agents.methods.get.id - resources.projects.resources.locations.resources.agents.methods.get.parameterOrder - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.location - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.required - resources.projects.resources.locations.resources.agents.methods.get.parameters.name.type - resources.projects.resources.locations.resources.agents.methods.get.path - resources.projects.resources.locations.resources.agents.methods.get.response.$ref - resources.projects.resources.locations.resources.agents.methods.get.scopes - resources.projects.resources.locations.resources.agents.methods.list.description - resources.projects.resources.locations.resources.agents.methods.list.flatPath - resources.projects.resources.locations.resources.agents.methods.list.httpMethod - resources.projects.resources.locations.resources.agents.methods.list.id - resources.projects.resources.locations.resources.agents.methods.list.parameterOrder - resources.projects.resources.locations.resources.agents.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.agents.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.agents.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.agents.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.agents.methods.list.path - resources.projects.resources.locations.resources.agents.methods.list.response.$ref - resources.projects.resources.locations.resources.agents.methods.list.scopes - resources.projects.resources.locations.resources.agents.methods.patch.description - resources.projects.resources.locations.resources.agents.methods.patch.flatPath - resources.projects.resources.locations.resources.agents.methods.patch.httpMethod - resources.projects.resources.locations.resources.agents.methods.patch.id - resources.projects.resources.locations.resources.agents.methods.patch.parameterOrder - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.agents.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.agents.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.agents.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.agents.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.agents.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.agents.methods.patch.path - resources.projects.resources.locations.resources.agents.methods.patch.request.$ref - resources.projects.resources.locations.resources.agents.methods.patch.response.$ref - resources.projects.resources.locations.resources.agents.methods.patch.scopes - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.flatPath - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.httpMethod - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.id - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameterOrder - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.evaluationMetricId.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.evaluationMetricId.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.evaluationMetricId.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.path - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.request.$ref - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.response.$ref - resources.projects.resources.locations.resources.evaluationMetrics.methods.create.scopes - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.flatPath - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.httpMethod - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.id - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameterOrder - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.path - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.response.$ref - resources.projects.resources.locations.resources.evaluationMetrics.methods.delete.scopes - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.flatPath - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.httpMethod - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.id - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameterOrder - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameters.name.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameters.name.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameters.name.required - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.parameters.name.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.path - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.response.$ref - resources.projects.resources.locations.resources.evaluationMetrics.methods.get.scopes - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.flatPath - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.httpMethod - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.id - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameterOrder - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.path - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.response.$ref - resources.projects.resources.locations.resources.evaluationMetrics.methods.list.scopes - resources.projects.resources.locations.resources.evaluationSets.methods.import.description - resources.projects.resources.locations.resources.evaluationSets.methods.import.flatPath - resources.projects.resources.locations.resources.evaluationSets.methods.import.httpMethod - resources.projects.resources.locations.resources.evaluationSets.methods.import.id - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameterOrder - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.location - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.pattern - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.required - resources.projects.resources.locations.resources.evaluationSets.methods.import.parameters.parent.type - resources.projects.resources.locations.resources.evaluationSets.methods.import.path - resources.projects.resources.locations.resources.evaluationSets.methods.import.request.$ref - resources.projects.resources.locations.resources.evaluationSets.methods.import.response.$ref - resources.projects.resources.locations.resources.evaluationSets.methods.import.scopes - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.description - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.format - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.location - resources.projects.resources.locations.resources.indexEndpoints.methods.mutateDeployedIndex.parameters.updateMask.type - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.description - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.flatPath - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.httpMethod - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.id - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.path - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.request.$ref - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.response.$ref - resources.projects.resources.locations.resources.memoryBanks.methods.ingestEvents.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.memoryId.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.create.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.generate.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.patch.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.purge.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.retrieve.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.request.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.methods.rollback.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.memories.resources.revisions.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.memoryBanks.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.request.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.activate.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.request.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.create.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.delete.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.get.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.list.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.request.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.patch.scopes - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.id - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.path - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.request.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.methods.suspend.scopes - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.id - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.path - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.id - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.path - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.onlineEvaluators.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.id - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.location - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.deployedModelId.type - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.description - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.location - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.required - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.parameters.endpoint.type - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.path - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.request.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.methods.responses.scopes - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.flatPath - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.httpMethod - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.id - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameterOrder - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.deployedModelId.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.description - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.location - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.pattern - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.required - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.parameters.endpoint.type - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.path - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.request.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.response.$ref - resources.projects.resources.locations.resources.publishers.resources.v1.resources.responses.methods.compact.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.description - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.id - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameters.parent.description - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameters.parent.location - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameters.parent.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameters.parent.required - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.parameters.parent.type - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.path - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.ingestEvents.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.id - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.path - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.scopes - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.flatPath - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.httpMethod - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.id - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameterOrder - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.description - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.location - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.pattern - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.required - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.type - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.path - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.request.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.response.$ref - resources.projects.resources.locations.resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.parameters.semanticGovernancePolicyId.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.create.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.delete.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.get.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.list.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.methods.patch.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicies.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.flatPath - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.httpMethod - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.id - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameterOrder - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.description - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.location - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.pattern - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.required - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.parameters.name.type - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.path - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.request.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.response.$ref - resources.projects.resources.locations.resources.semanticGovernancePolicyEngine.methods.deprovision.scopes - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.flatPath - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.httpMethod - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.id - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.path - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.response.$ref - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.delete.scopes - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.flatPath - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.httpMethod - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.id - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.path - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.response.$ref - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.flatPath - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.httpMethod - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.id - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.path - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.response.$ref - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.servingProfiles.resources.operations.methods.wait.scopes - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.flatPath - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.httpMethod - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.id - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameterOrder - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.pattern - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.required - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.name.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.description - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.format - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.location - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.type - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.path - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.response.$ref - resources.projects.resources.locations.resources.tuningJobs.resources.operations.methods.wait.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.pause.scopes - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.flatPath - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.httpMethod - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.id - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameterOrder - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.description - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.location - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.pattern - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.required - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.parameters.name.type - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.path - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.request.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.response.$ref - resources.reasoningEngines.resources.sandboxEnvironments.methods.resume.scopes - resources.semanticGovernancePolicies.resources.operations.methods.cancel.description - resources.semanticGovernancePolicies.resources.operations.methods.cancel.flatPath - resources.semanticGovernancePolicies.resources.operations.methods.cancel.httpMethod - resources.semanticGovernancePolicies.resources.operations.methods.cancel.id - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameterOrder - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.description - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.location - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.pattern - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.required - resources.semanticGovernancePolicies.resources.operations.methods.cancel.parameters.name.type - resources.semanticGovernancePolicies.resources.operations.methods.cancel.path - resources.semanticGovernancePolicies.resources.operations.methods.cancel.response.$ref - resources.semanticGovernancePolicies.resources.operations.methods.cancel.scopes - resources.semanticGovernancePolicies.resources.operations.methods.delete.description - resources.semanticGovernancePolicies.resources.operations.methods.delete.flatPath - resources.semanticGovernancePolicies.resources.operations.methods.delete.httpMethod - resources.semanticGovernancePolicies.resources.operations.methods.delete.id - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameterOrder - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.description - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.location - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.pattern - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.required - resources.semanticGovernancePolicies.resources.operations.methods.delete.parameters.name.type - resources.semanticGovernancePolicies.resources.operations.methods.delete.path - resources.semanticGovernancePolicies.resources.operations.methods.delete.response.$ref - resources.semanticGovernancePolicies.resources.operations.methods.delete.scopes - resources.semanticGovernancePolicies.resources.operations.methods.get.description - resources.semanticGovernancePolicies.resources.operations.methods.get.flatPath - resources.semanticGovernancePolicies.resources.operations.methods.get.httpMethod - resources.semanticGovernancePolicies.resources.operations.methods.get.id - resources.semanticGovernancePolicies.resources.operations.methods.get.parameterOrder - resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.description - resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.location - resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.pattern - resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.required - resources.semanticGovernancePolicies.resources.operations.methods.get.parameters.name.type - resources.semanticGovernancePolicies.resources.operations.methods.get.path - resources.semanticGovernancePolicies.resources.operations.methods.get.response.$ref - resources.semanticGovernancePolicies.resources.operations.methods.get.scopes - resources.semanticGovernancePolicies.resources.operations.methods.list.description - resources.semanticGovernancePolicies.resources.operations.methods.list.flatPath - resources.semanticGovernancePolicies.resources.operations.methods.list.httpMethod - resources.semanticGovernancePolicies.resources.operations.methods.list.id - resources.semanticGovernancePolicies.resources.operations.methods.list.parameterOrder - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.description - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.location - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.filter.type - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.description - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.location - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.pattern - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.required - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.name.type - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.description - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.format - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.location - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageSize.type - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.description - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.location - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.pageToken.type - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.semanticGovernancePolicies.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.semanticGovernancePolicies.resources.operations.methods.list.path - resources.semanticGovernancePolicies.resources.operations.methods.list.response.$ref - resources.semanticGovernancePolicies.resources.operations.methods.list.scopes - resources.semanticGovernancePolicies.resources.operations.methods.wait.description - resources.semanticGovernancePolicies.resources.operations.methods.wait.flatPath - resources.semanticGovernancePolicies.resources.operations.methods.wait.httpMethod - resources.semanticGovernancePolicies.resources.operations.methods.wait.id - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameterOrder - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.description - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.location - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.pattern - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.required - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.name.type - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.description - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.format - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.location - resources.semanticGovernancePolicies.resources.operations.methods.wait.parameters.timeout.type - resources.semanticGovernancePolicies.resources.operations.methods.wait.path - resources.semanticGovernancePolicies.resources.operations.methods.wait.response.$ref - resources.semanticGovernancePolicies.resources.operations.methods.wait.scopes - resources.servingProfiles.resources.operations.methods.cancel.description - resources.servingProfiles.resources.operations.methods.cancel.flatPath - resources.servingProfiles.resources.operations.methods.cancel.httpMethod - resources.servingProfiles.resources.operations.methods.cancel.id - resources.servingProfiles.resources.operations.methods.cancel.parameterOrder - resources.servingProfiles.resources.operations.methods.cancel.parameters.name.description - resources.servingProfiles.resources.operations.methods.cancel.parameters.name.location - resources.servingProfiles.resources.operations.methods.cancel.parameters.name.pattern - resources.servingProfiles.resources.operations.methods.cancel.parameters.name.required - resources.servingProfiles.resources.operations.methods.cancel.parameters.name.type - resources.servingProfiles.resources.operations.methods.cancel.path - resources.servingProfiles.resources.operations.methods.cancel.response.$ref - resources.servingProfiles.resources.operations.methods.cancel.scopes - resources.servingProfiles.resources.operations.methods.delete.description - resources.servingProfiles.resources.operations.methods.delete.flatPath - resources.servingProfiles.resources.operations.methods.delete.httpMethod - resources.servingProfiles.resources.operations.methods.delete.id - resources.servingProfiles.resources.operations.methods.delete.parameterOrder - resources.servingProfiles.resources.operations.methods.delete.parameters.name.description - resources.servingProfiles.resources.operations.methods.delete.parameters.name.location - resources.servingProfiles.resources.operations.methods.delete.parameters.name.pattern - resources.servingProfiles.resources.operations.methods.delete.parameters.name.required - resources.servingProfiles.resources.operations.methods.delete.parameters.name.type - resources.servingProfiles.resources.operations.methods.delete.path - resources.servingProfiles.resources.operations.methods.delete.response.$ref - resources.servingProfiles.resources.operations.methods.delete.scopes - resources.servingProfiles.resources.operations.methods.get.description - resources.servingProfiles.resources.operations.methods.get.flatPath - resources.servingProfiles.resources.operations.methods.get.httpMethod - resources.servingProfiles.resources.operations.methods.get.id - resources.servingProfiles.resources.operations.methods.get.parameterOrder - resources.servingProfiles.resources.operations.methods.get.parameters.name.description - resources.servingProfiles.resources.operations.methods.get.parameters.name.location - resources.servingProfiles.resources.operations.methods.get.parameters.name.pattern - resources.servingProfiles.resources.operations.methods.get.parameters.name.required - resources.servingProfiles.resources.operations.methods.get.parameters.name.type - resources.servingProfiles.resources.operations.methods.get.path - resources.servingProfiles.resources.operations.methods.get.response.$ref - resources.servingProfiles.resources.operations.methods.get.scopes - resources.servingProfiles.resources.operations.methods.list.description - resources.servingProfiles.resources.operations.methods.list.flatPath - resources.servingProfiles.resources.operations.methods.list.httpMethod - resources.servingProfiles.resources.operations.methods.list.id - resources.servingProfiles.resources.operations.methods.list.parameterOrder - resources.servingProfiles.resources.operations.methods.list.parameters.filter.description - resources.servingProfiles.resources.operations.methods.list.parameters.filter.location - resources.servingProfiles.resources.operations.methods.list.parameters.filter.type - resources.servingProfiles.resources.operations.methods.list.parameters.name.description - resources.servingProfiles.resources.operations.methods.list.parameters.name.location - resources.servingProfiles.resources.operations.methods.list.parameters.name.pattern - resources.servingProfiles.resources.operations.methods.list.parameters.name.required - resources.servingProfiles.resources.operations.methods.list.parameters.name.type - resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.description - resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.format - resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.location - resources.servingProfiles.resources.operations.methods.list.parameters.pageSize.type - resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.description - resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.location - resources.servingProfiles.resources.operations.methods.list.parameters.pageToken.type - resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.description - resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.location - resources.servingProfiles.resources.operations.methods.list.parameters.returnPartialSuccess.type - resources.servingProfiles.resources.operations.methods.list.path - resources.servingProfiles.resources.operations.methods.list.response.$ref - resources.servingProfiles.resources.operations.methods.list.scopes - resources.servingProfiles.resources.operations.methods.wait.description - resources.servingProfiles.resources.operations.methods.wait.flatPath - resources.servingProfiles.resources.operations.methods.wait.httpMethod - resources.servingProfiles.resources.operations.methods.wait.id - resources.servingProfiles.resources.operations.methods.wait.parameterOrder - resources.servingProfiles.resources.operations.methods.wait.parameters.name.description - resources.servingProfiles.resources.operations.methods.wait.parameters.name.location - resources.servingProfiles.resources.operations.methods.wait.parameters.name.pattern - resources.servingProfiles.resources.operations.methods.wait.parameters.name.required - resources.servingProfiles.resources.operations.methods.wait.parameters.name.type - resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.description - resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.format - resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.location - resources.servingProfiles.resources.operations.methods.wait.parameters.timeout.type - resources.servingProfiles.resources.operations.methods.wait.path - resources.servingProfiles.resources.operations.methods.wait.response.$ref - resources.servingProfiles.resources.operations.methods.wait.scopes - resources.tuningJobs.resources.operations.methods.wait.description - resources.tuningJobs.resources.operations.methods.wait.flatPath - resources.tuningJobs.resources.operations.methods.wait.httpMethod - resources.tuningJobs.resources.operations.methods.wait.id - resources.tuningJobs.resources.operations.methods.wait.parameterOrder - resources.tuningJobs.resources.operations.methods.wait.parameters.name.description - resources.tuningJobs.resources.operations.methods.wait.parameters.name.location - resources.tuningJobs.resources.operations.methods.wait.parameters.name.pattern - resources.tuningJobs.resources.operations.methods.wait.parameters.name.required - resources.tuningJobs.resources.operations.methods.wait.parameters.name.type - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.description - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.format - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.location - resources.tuningJobs.resources.operations.methods.wait.parameters.timeout.type - resources.tuningJobs.resources.operations.methods.wait.path - resources.tuningJobs.resources.operations.methods.wait.response.$ref - resources.tuningJobs.resources.operations.methods.wait.scopes - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.anchorLastFrame.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.anchorLastFrame.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.cfgScale.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.colorAlignment.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.additionalProperties.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.additionalProperties.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.customParameters.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.exrColorSpaceOverride.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.omniRewriter.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.originalRequestJson.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.originalRequestJson.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.schedulingConfig.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.schedulingConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.seamless.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.seamless.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.$ref - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.spatialAlignment.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.properties.enable.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.properties.enable.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.maxChunkDuration.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.format - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.properties.rewriterInputFps.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.properties.enable.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.properties.enable.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.id - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.properties.enableRetry.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.properties.enableRetry.type - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig.type - schemas.CloudAiLargeModelsVisionSeamless.id - schemas.CloudAiLargeModelsVisionSeamless.properties.loop.description - schemas.CloudAiLargeModelsVisionSeamless.properties.loop.type - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateHorizontal.description - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateHorizontal.type - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateVertical.description - schemas.CloudAiLargeModelsVisionSeamless.properties.tessellateVertical.type - schemas.CloudAiLargeModelsVisionSeamless.type - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata.description - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata.id - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata.type - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest.description - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest.id - schemas.GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest.type - schemas.GoogleCloudAiplatformV1Agent.description - schemas.GoogleCloudAiplatformV1Agent.id - schemas.GoogleCloudAiplatformV1Agent.properties.base_agent.description - schemas.GoogleCloudAiplatformV1Agent.properties.base_agent.type - schemas.GoogleCloudAiplatformV1Agent.properties.base_environment.description - schemas.GoogleCloudAiplatformV1Agent.properties.base_environment.type - schemas.GoogleCloudAiplatformV1Agent.properties.created.description - schemas.GoogleCloudAiplatformV1Agent.properties.created.format - schemas.GoogleCloudAiplatformV1Agent.properties.created.readOnly - schemas.GoogleCloudAiplatformV1Agent.properties.created.type - schemas.GoogleCloudAiplatformV1Agent.properties.description.description - schemas.GoogleCloudAiplatformV1Agent.properties.description.type - schemas.GoogleCloudAiplatformV1Agent.properties.id.description - schemas.GoogleCloudAiplatformV1Agent.properties.id.type - schemas.GoogleCloudAiplatformV1Agent.properties.metadata.additionalProperties.type - schemas.GoogleCloudAiplatformV1Agent.properties.metadata.description - schemas.GoogleCloudAiplatformV1Agent.properties.metadata.type - schemas.GoogleCloudAiplatformV1Agent.properties.name.description - schemas.GoogleCloudAiplatformV1Agent.properties.name.type - schemas.GoogleCloudAiplatformV1Agent.properties.object.description - schemas.GoogleCloudAiplatformV1Agent.properties.object.readOnly - schemas.GoogleCloudAiplatformV1Agent.properties.object.type - schemas.GoogleCloudAiplatformV1Agent.properties.system_instruction.description - schemas.GoogleCloudAiplatformV1Agent.properties.system_instruction.type - schemas.GoogleCloudAiplatformV1Agent.properties.tools.description - schemas.GoogleCloudAiplatformV1Agent.properties.tools.items.$ref - schemas.GoogleCloudAiplatformV1Agent.properties.tools.type - schemas.GoogleCloudAiplatformV1Agent.properties.updated.description - schemas.GoogleCloudAiplatformV1Agent.properties.updated.format - schemas.GoogleCloudAiplatformV1Agent.properties.updated.readOnly - schemas.GoogleCloudAiplatformV1Agent.properties.updated.type - schemas.GoogleCloudAiplatformV1Agent.type - schemas.GoogleCloudAiplatformV1AgentConfig.description - schemas.GoogleCloudAiplatformV1AgentConfig.id - schemas.GoogleCloudAiplatformV1AgentConfig.properties.agentId.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.agentId.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.agentType.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.agentType.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.description.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.description.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.instruction.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.instruction.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.subAgents.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.subAgents.items.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.subAgents.type - schemas.GoogleCloudAiplatformV1AgentConfig.properties.tools.description - schemas.GoogleCloudAiplatformV1AgentConfig.properties.tools.items.$ref - schemas.GoogleCloudAiplatformV1AgentConfig.properties.tools.type - schemas.GoogleCloudAiplatformV1AgentConfig.type - schemas.GoogleCloudAiplatformV1AgentData.description - schemas.GoogleCloudAiplatformV1AgentData.id - schemas.GoogleCloudAiplatformV1AgentData.properties.agents.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1AgentData.properties.agents.description - schemas.GoogleCloudAiplatformV1AgentData.properties.agents.type - schemas.GoogleCloudAiplatformV1AgentData.properties.turns.description - schemas.GoogleCloudAiplatformV1AgentData.properties.turns.items.$ref - schemas.GoogleCloudAiplatformV1AgentData.properties.turns.type - schemas.GoogleCloudAiplatformV1AgentData.type - schemas.GoogleCloudAiplatformV1AgentEvent.description - schemas.GoogleCloudAiplatformV1AgentEvent.id - schemas.GoogleCloudAiplatformV1AgentEvent.properties.activeTools.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.activeTools.items.$ref - schemas.GoogleCloudAiplatformV1AgentEvent.properties.activeTools.type - schemas.GoogleCloudAiplatformV1AgentEvent.properties.author.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.author.type - schemas.GoogleCloudAiplatformV1AgentEvent.properties.content.$ref - schemas.GoogleCloudAiplatformV1AgentEvent.properties.content.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.eventTime.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.eventTime.format - schemas.GoogleCloudAiplatformV1AgentEvent.properties.eventTime.type - schemas.GoogleCloudAiplatformV1AgentEvent.properties.stateDelta.additionalProperties.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.stateDelta.additionalProperties.type - schemas.GoogleCloudAiplatformV1AgentEvent.properties.stateDelta.description - schemas.GoogleCloudAiplatformV1AgentEvent.properties.stateDelta.type - schemas.GoogleCloudAiplatformV1AgentEvent.type - schemas.GoogleCloudAiplatformV1AgentTool.description - schemas.GoogleCloudAiplatformV1AgentTool.id - schemas.GoogleCloudAiplatformV1AgentTool.properties.headers.additionalProperties.type - schemas.GoogleCloudAiplatformV1AgentTool.properties.headers.description - schemas.GoogleCloudAiplatformV1AgentTool.properties.headers.type - schemas.GoogleCloudAiplatformV1AgentTool.properties.name.description - schemas.GoogleCloudAiplatformV1AgentTool.properties.name.type - schemas.GoogleCloudAiplatformV1AgentTool.properties.type.description - schemas.GoogleCloudAiplatformV1AgentTool.properties.type.type - schemas.GoogleCloudAiplatformV1AgentTool.properties.url.description - schemas.GoogleCloudAiplatformV1AgentTool.properties.url.type - schemas.GoogleCloudAiplatformV1AgentTool.type - schemas.GoogleCloudAiplatformV1AudioResponseFormat.description - schemas.GoogleCloudAiplatformV1AudioResponseFormat.id - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.bitRate.description - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.bitRate.format - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.bitRate.type - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.sampleRate.description - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.sampleRate.format - schemas.GoogleCloudAiplatformV1AudioResponseFormat.properties.sampleRate.type - schemas.GoogleCloudAiplatformV1AudioResponseFormat.type - schemas.GoogleCloudAiplatformV1AudioTranscription.description - schemas.GoogleCloudAiplatformV1AudioTranscription.id - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.speakerLabel.description - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.speakerLabel.type - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.text.description - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.text.type - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.words.description - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.words.items.$ref - schemas.GoogleCloudAiplatformV1AudioTranscription.properties.words.type - schemas.GoogleCloudAiplatformV1AudioTranscription.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.id - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.adaptationPhrases.deprecated - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.adaptationPhrases.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.adaptationPhrases.items.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.adaptationPhrases.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.customVocabulary.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.customVocabulary.items.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.customVocabulary.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.diarization.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.diarization.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.languageAuto.$ref - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.languageAuto.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.languageHints.$ref - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.languageHints.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.wordTimestamp.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.properties.wordTimestamp.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfig.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto.id - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.id - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.properties.languageCodes.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.properties.languageCodes.items.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.properties.languageCodes.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.id - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.endOffset.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.endOffset.format - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.endOffset.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.startOffset.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.startOffset.format - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.startOffset.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.word.description - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.properties.word.type - schemas.GoogleCloudAiplatformV1AudioTranscriptionWordInfo.type - schemas.GoogleCloudAiplatformV1CandidateResponse.properties.agentData.$ref - schemas.GoogleCloudAiplatformV1CandidateResponse.properties.agentData.description - schemas.GoogleCloudAiplatformV1CandidateResult.properties.error.$ref - schemas.GoogleCloudAiplatformV1CandidateResult.properties.error.description - schemas.GoogleCloudAiplatformV1CandidateResult.properties.error.readOnly - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.id - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.project.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.project.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.resourceLabels.additionalProperties.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.resourceLabels.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.resourceLabels.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.resourceType.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.resourceType.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.tracingContext.$ref - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.properties.tracingContext.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfig.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.id - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.conversationId.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.conversationId.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.spanId.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.spanId.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.traceId.description - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.properties.traceId.type - schemas.GoogleCloudAiplatformV1CloudLoggingConfigTracingContext.type - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.id.description - schemas.GoogleCloudAiplatformV1CodeExecutionResult.properties.id.type - schemas.GoogleCloudAiplatformV1ConversationTurn.description - schemas.GoogleCloudAiplatformV1ConversationTurn.id - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.events.description - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.events.items.$ref - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.events.type - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.turnId.description - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.turnId.type - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.turnIndex.description - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.turnIndex.format - schemas.GoogleCloudAiplatformV1ConversationTurn.properties.turnIndex.type - schemas.GoogleCloudAiplatformV1ConversationTurn.type - schemas.GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata.description - schemas.GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata.id - schemas.GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata.type - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.description - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.id - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.properties.genericMetadata.readOnly - schemas.GoogleCloudAiplatformV1CreateServingProfileOperationMetadata.type - schemas.GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata.description - schemas.GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata.id - schemas.GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata.type - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.description - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.id - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.description - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.properties.force.type - schemas.GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.id - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.createTime.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.createTime.format - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.createTime.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.description.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.description.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.displayName.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.displayName.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.encryptionSpec.$ref - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.encryptionSpec.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.labels.additionalProperties.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.labels.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.labels.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.metric.$ref - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.metric.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.name.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.name.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.updateTime.description - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.updateTime.format - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1EvaluationMetric.properties.updateTime.type - schemas.GoogleCloudAiplatformV1EvaluationMetric.type - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.agentData.$ref - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.agentData.description - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.userScenario.$ref - schemas.GoogleCloudAiplatformV1EvaluationPrompt.properties.userScenario.description - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.description - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.id - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.properties.conversationPlan.description - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.properties.conversationPlan.type - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.properties.startingPrompt.description - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.properties.startingPrompt.type - schemas.GoogleCloudAiplatformV1EvaluationPromptUserScenario.type - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.$ref - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.cloudLoggingConfig.description - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.lossAnalysisConfig.description - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.lossAnalysisConfig.items.$ref - schemas.GoogleCloudAiplatformV1EvaluationRunEvaluationConfig.properties.lossAnalysisConfig.type - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.agents.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.agents.description - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.agents.type - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.promptTemplate.$ref - schemas.GoogleCloudAiplatformV1EvaluationRunInferenceConfig.properties.promptTemplate.description - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.agentConfigs.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.agentConfigs.description - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.agentConfigs.type - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.encryptionSpec.$ref - schemas.GoogleCloudAiplatformV1EvaluationSet.properties.encryptionSpec.description - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.id.description - schemas.GoogleCloudAiplatformV1ExecutableCode.properties.id.type - schemas.GoogleCloudAiplatformV1FunctionCall.properties.id.description - schemas.GoogleCloudAiplatformV1FunctionCall.properties.id.type - schemas.GoogleCloudAiplatformV1FunctionResponse.properties.id.description - schemas.GoogleCloudAiplatformV1FunctionResponse.properties.id.type - schemas.GoogleCloudAiplatformV1GatewayConfig.description - schemas.GoogleCloudAiplatformV1GatewayConfig.id - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.allowedProjects.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.allowedProjects.items.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.allowedProjects.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.dnsRecord.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.dnsRecord.readOnly - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.dnsRecord.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.dnsZoneName.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.dnsZoneName.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.ipAddress.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.ipAddress.readOnly - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.ipAddress.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.network.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.network.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.pscEndpoint.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.pscEndpoint.readOnly - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.pscEndpoint.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.state.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.state.enum - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.state.readOnly - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.state.type - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.subnetwork.description - schemas.GoogleCloudAiplatformV1GatewayConfig.properties.subnetwork.type - schemas.GoogleCloudAiplatformV1GatewayConfig.type - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.id - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.configs.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.configs.items.$ref - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.configs.type - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.evaluationSet.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.evaluationSet.type - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.inlineResults.$ref - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.properties.inlineResults.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequest.type - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.id - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.properties.evaluationResults.description - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.properties.evaluationResults.items.$ref - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.properties.evaluationResults.type - schemas.GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.id - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.agents.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.agents.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.agents.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.allowCrossRegionModel.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.allowCrossRegionModel.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.rootAgentId.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.rootAgentId.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.userScenarioGenerationConfig.$ref - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.properties.userScenarioGenerationConfig.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosRequest.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.id - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.properties.userScenarios.description - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.properties.userScenarios.items.$ref - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.properties.userScenarios.type - schemas.GoogleCloudAiplatformV1GenerateUserScenariosResponse.type - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.audioTranscriptionConfig.$ref - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.audioTranscriptionConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.imageConfig.deprecated - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseFormat.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseFormat.items.$ref - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseFormat.type - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseJsonSchema.deprecated - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseMimeType.deprecated - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseSchema.deprecated - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.enableWidget.deprecated - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.groundingTypes.$ref - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.groundingTypes.description - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.description - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.id - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.properties.places.$ref - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.properties.places.description - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.properties.routing.$ref - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.properties.routing.description - schemas.GoogleCloudAiplatformV1GoogleMapsGroundingTypes.type - schemas.GoogleCloudAiplatformV1GoogleMapsPlaces.description - schemas.GoogleCloudAiplatformV1GoogleMapsPlaces.id - schemas.GoogleCloudAiplatformV1GoogleMapsPlaces.type - schemas.GoogleCloudAiplatformV1GoogleMapsRouting.description - schemas.GoogleCloudAiplatformV1GoogleMapsRouting.id - schemas.GoogleCloudAiplatformV1GoogleMapsRouting.type - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.googleMapsWidgetContextToken.deprecated - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.retrievalQueries.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.retrievalQueries.items.type - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.retrievalQueries.type - schemas.GoogleCloudAiplatformV1ImageResponseFormat.description - schemas.GoogleCloudAiplatformV1ImageResponseFormat.id - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.aspectRatio.description - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.aspectRatio.enum - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.aspectRatio.type - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.imageSize.description - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.imageSize.enum - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.imageSize.enumDescriptions - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.imageSize.type - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1ImageResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1ImageResponseFormat.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.agentEngineSource.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.agentEngineSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.bigquerySource.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.bigquerySource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.cloudTraceSource.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.cloudTraceSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.evaluationSet.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.evaluationSet.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.gcsDestination.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.gcsDestination.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.gcsSource.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.gcsSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.inlineSource.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.properties.inlineSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequest.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.location.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.location.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.projectId.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.projectId.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.reasoningEngineId.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.reasoningEngineId.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.items.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.properties.sessionIds.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.projectId.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.projectId.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.items.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.sessionIds.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.items.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.properties.traceIds.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.properties.importSchemaConfig.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.properties.importSchemaConfig.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.enum - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.enumDescriptions - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormat.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormatVersion.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.properties.dataFormatVersion.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.id - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.properties.content.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.properties.content.format - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.properties.content.type - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.properties.importSchemaConfig.$ref - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.properties.importSchemaConfig.description - schemas.GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.id - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.directContentsSource.$ref - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.directContentsSource.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.disableMemoryRevisions.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.disableMemoryRevisions.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.forceFlush.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.forceFlush.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.generationTriggerConfig.$ref - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.generationTriggerConfig.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadata.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadata.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadata.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadataMergeStrategy.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadataMergeStrategy.enum - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadataMergeStrategy.enumDescriptions - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.metadataMergeStrategy.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionExpireTime.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionExpireTime.format - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionExpireTime.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionLabels.additionalProperties.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionLabels.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionLabels.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionTtl.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionTtl.format - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.revisionTtl.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.scope.additionalProperties.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.scope.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.scope.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.streamId.description - schemas.GoogleCloudAiplatformV1IngestEventsRequest.properties.streamId.type - schemas.GoogleCloudAiplatformV1IngestEventsRequest.type - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.id - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.properties.events.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.properties.events.items.$ref - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.properties.events.type - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSource.type - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.id - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.content.$ref - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.content.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.eventId.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.eventId.type - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.eventTime.description - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.eventTime.format - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.properties.eventTime.type - schemas.GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent.type - schemas.GoogleCloudAiplatformV1ListAgentsResponse.description - schemas.GoogleCloudAiplatformV1ListAgentsResponse.id - schemas.GoogleCloudAiplatformV1ListAgentsResponse.properties.agents.description - schemas.GoogleCloudAiplatformV1ListAgentsResponse.properties.agents.items.$ref - schemas.GoogleCloudAiplatformV1ListAgentsResponse.properties.agents.type - schemas.GoogleCloudAiplatformV1ListAgentsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1ListAgentsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1ListAgentsResponse.type - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.description - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.id - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.properties.evaluationMetrics.description - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.properties.evaluationMetrics.items.$ref - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.properties.evaluationMetrics.type - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1ListEvaluationMetricsResponse.type - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.description - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.id - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.properties.onlineEvaluators.description - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.properties.onlineEvaluators.items.$ref - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.properties.onlineEvaluators.type - schemas.GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse.type - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.description - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.id - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.properties.nextPageToken.description - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.properties.nextPageToken.type - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.description - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.items.$ref - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.properties.semanticGovernancePolicies.type - schemas.GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse.type - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.description - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.id - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.properties.candidate.description - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.properties.candidate.type - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.properties.metric.description - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.properties.metric.type - schemas.GoogleCloudAiplatformV1LossAnalysisConfig.type - schemas.GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.description - schemas.GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.format - schemas.GoogleCloudAiplatformV1MemoryGenerationTriggerConfigGenerationTriggerRule.properties.overlapEventCount.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.$ref - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpec.properties.shieldedInstanceConfig.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.id - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableIntegrityMonitoring.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableIntegrityMonitoring.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableSecureBoot.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableSecureBoot.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableVtpm.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.properties.enableVtpm.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.$ref - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.customContainerImage.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.$ref - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime.properties.vmImage.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.id - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.repository.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.repository.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.tag.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.properties.tag.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.id - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.family.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.family.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.name.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.name.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.project.description - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.properties.project.type - schemas.GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.id - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.agentResource.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.agentResource.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.cloudObservability.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.cloudObservability.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.config.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.config.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.createTime.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.createTime.format - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.createTime.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.displayName.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.displayName.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.metricSources.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.metricSources.items.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.metricSources.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.name.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.name.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.state.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.state.enum - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.state.readOnly - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.state.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.stateDetails.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.stateDetails.items.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.stateDetails.readOnly - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.stateDetails.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.updateTime.description - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.updateTime.format - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1OnlineEvaluator.properties.updateTime.type - schemas.GoogleCloudAiplatformV1OnlineEvaluator.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.logView.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.logView.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.openTelemetry.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.openTelemetry.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.traceScope.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.traceScope.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.traceView.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.properties.traceView.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.comparisonOperator.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.comparisonOperator.enum - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.comparisonOperator.enumDescriptions - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.comparisonOperator.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.value.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.value.format - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.properties.value.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry.properties.semconvVersion.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry.properties.semconvVersion.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.properties.filter.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.properties.filter.items.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.properties.filter.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.properties.duration.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.properties.duration.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.properties.totalTokenUsage.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.properties.totalTokenUsage.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.properties.maxEvaluatedSamplesPerRun.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.properties.maxEvaluatedSamplesPerRun.format - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.properties.maxEvaluatedSamplesPerRun.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.properties.randomSampling.$ref - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.properties.randomSampling.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfig.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.properties.percentage.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.properties.percentage.format - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.properties.percentage.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.id - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.properties.message.description - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.properties.message.readOnly - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.properties.message.type - schemas.GoogleCloudAiplatformV1OnlineEvaluatorStateDetails.type - schemas.GoogleCloudAiplatformV1Part.properties.audioTranscription.$ref - schemas.GoogleCloudAiplatformV1Part.properties.audioTranscription.description - schemas.GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest.description - schemas.GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest.id - schemas.GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.buildSpec.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpec.properties.buildSpec.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.id - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.properties.serviceAccount.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.properties.serviceAccount.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.properties.workerPool.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.properties.workerPool.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec.properties.port.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec.properties.port.format - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec.properties.port.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.agentGatewayConfig.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec.properties.agentGatewayConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.id - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.properties.agentToAnywhereConfig.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.properties.agentToAnywhereConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.properties.clientToAgentConfig.$ref - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.properties.clientToAgentConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig.id - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig.properties.agentGateway.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig.properties.agentGateway.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig.id - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig.properties.agentGateway.description - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig.properties.agentGateway.type - schemas.GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig.type - schemas.GoogleCloudAiplatformV1ResponseFormat.description - schemas.GoogleCloudAiplatformV1ResponseFormat.id - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.audio.$ref - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.audio.description - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.image.$ref - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.image.description - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.text.$ref - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.text.description - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.video.$ref - schemas.GoogleCloudAiplatformV1ResponseFormat.properties.video.description - schemas.GoogleCloudAiplatformV1ResponseFormat.type - schemas.GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest.description - schemas.GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest.id - schemas.GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.resources.$ref - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.resources.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.customerVpcNetwork.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.items.$ref - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.dnsPeeringConfigs.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig.properties.networkAttachment.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.id - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.domain.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.domain.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetNetwork.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetNetwork.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetProject.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.properties.targetProject.type - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.id - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.agent.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.agent.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.agentIdentity.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.agentIdentity.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.agentIdentity.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.createTime.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.createTime.format - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.createTime.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.description.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.description.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.displayName.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.displayName.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.etag.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.etag.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.mcpTools.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.mcpTools.items.$ref - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.mcpTools.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.name.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.name.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.naturalLanguageConstraint.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.naturalLanguageConstraint.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.updateTime.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.updateTime.format - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.updateTime.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.id - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.createTime.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.createTime.format - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.createTime.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.createTime.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.gatewayConfigs.additionalProperties.$ref - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.gatewayConfigs.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.gatewayConfigs.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.ipAddress.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.ipAddress.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.ipAddress.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.name.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.name.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscForwardingRule.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscForwardingRule.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscForwardingRule.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.pscServiceAttachment.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.state.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.state.enum - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.state.enumDescriptions - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.state.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.state.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.updateTime.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.updateTime.format - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.updateTime.readOnly - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.properties.updateTime.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyEngine.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.id - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.properties.mcpServer.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.properties.mcpServer.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.properties.tools.description - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.properties.tools.items.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.properties.tools.type - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool.type - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata.description - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata.id - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata.type - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest.description - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest.id - schemas.GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest.type - schemas.GoogleCloudAiplatformV1TextResponseFormat.description - schemas.GoogleCloudAiplatformV1TextResponseFormat.id - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.mimeType.description - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.mimeType.enum - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.mimeType.enumDescriptions - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.mimeType.type - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.schema.description - schemas.GoogleCloudAiplatformV1TextResponseFormat.properties.schema.type - schemas.GoogleCloudAiplatformV1TextResponseFormat.type - schemas.GoogleCloudAiplatformV1Tool.properties.exaAiSearch.$ref - schemas.GoogleCloudAiplatformV1Tool.properties.exaAiSearch.description - schemas.GoogleCloudAiplatformV1ToolComputerUse.properties.enablePromptInjectionDetection.description - schemas.GoogleCloudAiplatformV1ToolComputerUse.properties.enablePromptInjectionDetection.type - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.description - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.id - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.apiKey.description - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.apiKey.type - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.customConfigs.additionalProperties.description - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.customConfigs.additionalProperties.type - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.customConfigs.description - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.properties.customConfigs.type - schemas.GoogleCloudAiplatformV1ToolExaAiSearch.type - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableDataRetention.deprecated - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableDataRetention.description - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableDataRetention.type - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableZeroDataRetention.description - schemas.GoogleCloudAiplatformV1ToolParallelAiSearch.properties.enableZeroDataRetention.type - schemas.GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata.description - schemas.GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata.id - schemas.GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata.properties.genericMetadata.$ref - schemas.GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata.properties.genericMetadata.description - schemas.GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata.type - schemas.GoogleCloudAiplatformV1UserScenario.description - schemas.GoogleCloudAiplatformV1UserScenario.id - schemas.GoogleCloudAiplatformV1UserScenario.properties.conversationPlan.description - schemas.GoogleCloudAiplatformV1UserScenario.properties.conversationPlan.type - schemas.GoogleCloudAiplatformV1UserScenario.properties.startingPrompt.description - schemas.GoogleCloudAiplatformV1UserScenario.properties.startingPrompt.type - schemas.GoogleCloudAiplatformV1UserScenario.properties.testCaseTitle.description - schemas.GoogleCloudAiplatformV1UserScenario.properties.testCaseTitle.type - schemas.GoogleCloudAiplatformV1UserScenario.type - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.description - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.id - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.environmentData.description - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.environmentData.type - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.modelName.description - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.modelName.type - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.simulationInstruction.description - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.simulationInstruction.type - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.userScenarioCount.description - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.userScenarioCount.format - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.properties.userScenarioCount.type - schemas.GoogleCloudAiplatformV1UserScenarioGenerationConfig.type - schemas.GoogleCloudAiplatformV1VideoResponseFormat.description - schemas.GoogleCloudAiplatformV1VideoResponseFormat.id - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.aspectRatio.description - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.aspectRatio.enum - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.aspectRatio.enumDescriptions - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.aspectRatio.type - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.delivery.description - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.delivery.enum - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.delivery.enumDescriptions - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.delivery.type - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.duration.description - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.duration.format - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.duration.type - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.gcsUri.description - schemas.GoogleCloudAiplatformV1VideoResponseFormat.properties.gcsUri.type - schemas.GoogleCloudAiplatformV1VideoResponseFormat.type The following keys were changed: - resources.projects.resources.locations.resources.reasoningEngines.resources.memories.methods.patch.parameters.updateMask.description - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.codec.enum - schemas.CloudAiLargeModelsVisionGenerateVideoExperiments.properties.codec.enumDescriptions - schemas.GoogleCloudAiplatformV1AutomaticResources.description - schemas.GoogleCloudAiplatformV1AutomaticResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1BatchDedicatedResources.properties.startingReplicaCount.description - schemas.GoogleCloudAiplatformV1DedicatedResources.properties.maxReplicaCount.description - schemas.GoogleCloudAiplatformV1EvaluateInstancesRequest.properties.autoraterConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.imageConfig.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseJsonSchema.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseMimeType.description - schemas.GoogleCloudAiplatformV1GenerationConfig.properties.responseSchema.description - schemas.GoogleCloudAiplatformV1GoogleMaps.properties.enableWidget.description - schemas.GoogleCloudAiplatformV1GroundingMetadata.properties.googleMapsWidgetContextToken.description - schemas.GoogleCloudAiplatformV1MachineSpec.properties.acceleratorCount.description - schemas.GoogleCloudAiplatformV1MachineSpec.properties.machineType.description - schemas.GoogleCloudAiplatformV1Model.properties.containerSpec.description - schemas.GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError.properties.errorType.enum - schemas.GoogleCloudAiplatformV1NearestNeighborSearchOperationMetadataRecordError.properties.errorType.enumDescriptions - schemas.GoogleCloudAiplatformV1PersistentDiskSpec.description - schemas.GoogleCloudAiplatformV1PersistentDiskSpec.properties.diskType.description - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.defaultContainerCategory.enum - schemas.GoogleCloudAiplatformV1SandboxEnvironmentTemplateDefaultContainerEnvironment.properties.defaultContainerCategory.enumDescriptions - schemas.GoogleCloudAiplatformV1ToolComputerUse.properties.environment.enum - schemas.GoogleCloudAiplatformV1ToolComputerUse.properties.environment.enumDescriptions --- discovery/aiplatform-v1.json | 6390 +- discovery/aiplatform-v1beta1.json | 18205 ++++-- src/apis/aiplatform/index.ts | 5 +- src/apis/aiplatform/v1.ts | 98045 ++++++++++++++++------------ 4 files changed, 75779 insertions(+), 46866 deletions(-) diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index a641b00c5b2..0a104c1f413 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -4024,6 +4024,326 @@ } } }, + "memoryBanks": { + "resources": { + "memories": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.memoryBanks.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.memoryBanks.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/operations", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "metadataStores": { "resources": { "artifacts": { @@ -5784,6 +6104,166 @@ } } }, + "onlineEvaluators": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.onlineEvaluators.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.onlineEvaluators.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.onlineEvaluators.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.onlineEvaluators.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^onlineEvaluators/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.onlineEvaluators.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "cancel": { @@ -6539,6 +7019,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateLossClusters": { + "description": "Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateLossClusters", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateLossClusters", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateLossClusters", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateLossClustersRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "generateSyntheticData": { "description": "Generates synthetic (artificial) data based on a description", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", @@ -6567,6 +7075,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateUserScenarios": { + "description": "Generates user scenarios for agent evaluation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateUserScenarios", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}:generateUserScenarios", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateUserScenariosRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1GenerateUserScenariosResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", @@ -6617,6 +7153,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getSemanticGovernancePolicyEngine": { + "description": "Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getSemanticGovernancePolicyEngine", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicyEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "flatPath": "v1/projects/{projectsId}/locations", @@ -6719,9 +7280,200 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateSemanticGovernancePolicyEngine": { + "description": "Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateSemanticGovernancePolicyEngine", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicyEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { + "agents": { + "methods": { + "create": { + "description": "Creates an agent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/agents", + "request": { + "$ref": "GoogleCloudAiplatformV1Agent" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an agent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves an agent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists agents in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/agents", + "response": { + "$ref": "GoogleCloudAiplatformV1ListAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an agent.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.agents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. If not present, all fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Agent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "batchPredictionJobs": { "methods": { "cancel": { @@ -10867,6 +11619,139 @@ } } }, + "evaluationMetrics": { + "methods": { + "create": { + "description": "Creates an EvaluationMetric.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationMetrics.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "evaluationMetricId": { + "description": "Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationMetrics", + "request": { + "$ref": "GoogleCloudAiplatformV1EvaluationMetric" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationMetric" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an EvaluationMetric.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.evaluationMetrics.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an EvaluationMetric.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics/{evaluationMetricsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationMetrics.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EvaluationMetric resource. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluationMetrics/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1EvaluationMetric" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists EvaluationMetrics.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationMetrics", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.evaluationMetrics.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of EvaluationMetrics to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationMetrics", + "response": { + "$ref": "GoogleCloudAiplatformV1ListEvaluationMetricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "evaluationRuns": { "methods": { "cancel": { @@ -11103,6 +11988,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "import": { + "description": "Imports an Evaluation Set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/evaluationSets:import", + "request": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Evaluation Sets.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluationSets", @@ -14892,6 +15805,12 @@ "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "v1/{+indexEndpoint}:mutateDeployedIndex", @@ -15532,188 +16451,86 @@ } } }, - "metadataStores": { + "memoryBanks": { "methods": { - "create": { - "description": "Initializes a MetadataStore, including allocation of resources.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "ingestEvents": { + "description": "Ingests events for a Memory Bank.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.create", + "id": "aiplatform.projects.locations.memoryBanks.ingestEvents", "parameterOrder": [ "parent" ], "parameters": { - "metadataStoreId": { - "description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", + "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/metadataStores", + "path": "v1/{+parent}:ingestEvents", "request": { - "$ref": "GoogleCloudAiplatformV1MetadataStore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "deprecated": true, - "description": "Deprecated: Field is no longer supported.", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } + "$ref": "GoogleCloudAiplatformV1IngestEventsRequest" }, - "path": "v1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "get": { - "description": "Retrieves a specific MetadataStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1MetadataStore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists MetadataStores for a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/metadataStores", - "response": { - "$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } }, "resources": { - "artifacts": { + "memories": { "methods": { "create": { - "description": "Creates an Artifact associated with a MetadataStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "description": "Create a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.create", + "id": "aiplatform.projects.locations.memoryBanks.memories.create", "parameterOrder": [ "parent" ], "parameters": { - "artifactId": { - "description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)", + "memoryId": { + "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/artifacts", + "path": "v1/{+parent}/memories", "request": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleCloudAiplatformV1Memory" }, "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes an Artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "description": "Delete a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", + "id": "aiplatform.projects.locations.memoryBanks.memories.delete", "parameterOrder": [ "name" ], "parameters": { - "etag": { - "description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", - "location": "query", - "type": "string" - }, "name": { - "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } @@ -15726,100 +16543,123 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { - "description": "Retrieves a specific Artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "description": "Get a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.get", + "id": "aiplatform.projects.locations.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleCloudAiplatformV1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists Artifacts in the MetadataStore.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "description": "List Memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.list", + "id": "aiplatform.projects.locations.memoryBanks.memories.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", "location": "query", "type": "string" }, "orderBy": { - "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/artifacts", + "path": "v1/{+parent}/memories", "response": { - "$ref": "GoogleCloudAiplatformV1ListArtifactsResponse" + "$ref": "GoogleCloudAiplatformV1ListMemoriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates a stored Artifact.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "description": "Update a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", + "id": "aiplatform.projects.locations.memoryBanks.memories.patch", "parameterOrder": [ "name" ], "parameters": { - "allowMissing": { - "description": "If set to true, and the Artifact is not found, a new Artifact is created.", - "location": "query", - "type": "boolean" - }, "name": { - "description": "Output only. The resource name of the Artifact.", + "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. A FieldMask indicating which fields should be updated.", + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -15827,35 +16667,35 @@ }, "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleCloudAiplatformV1Memory" }, "response": { - "$ref": "GoogleCloudAiplatformV1Artifact" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "purge": { - "description": "Purges Artifacts.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", + "description": "Purge memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", + "id": "aiplatform.projects.locations.memoryBanks.memories.purge", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/artifacts:purge", + "path": "v1/{+parent}/memories:purge", "request": { - "$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest" + "$ref": "GoogleCloudAiplatformV1PurgeMemoriesRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -15864,37 +16704,57 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "queryArtifactLineageSubgraph": { - "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.retrieve", "parameterOrder": [ - "artifact" + "parent" ], "parameters": { - "artifact": { - "description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" - }, - "filter": { - "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", - "location": "query", + } + }, + "path": "v1/{+parent}/memories:retrieve", + "request": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1RetrieveMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.rollback", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, "type": "string" - }, - "maxHops": { - "description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.", - "format": "int32", - "location": "query", - "type": "integer" } }, - "path": "v1/{+artifact}:queryArtifactLineageSubgraph", + "path": "v1/{+name}:rollback", + "request": { + "$ref": "GoogleCloudAiplatformV1RollbackMemoryRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -15906,9 +16766,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -15916,7 +16776,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15931,9 +16791,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -15941,7 +16801,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15956,9 +16816,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -15966,7 +16826,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -15981,9 +16841,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -15996,7 +16856,763 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "revisions": { + "methods": { + "get": { + "description": "Get a Memory Revision.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1MemoryRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListMemoryRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.memoryBanks.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "metadataStores": { + "methods": { + "create": { + "description": "Initializes a MetadataStore, including allocation of resources.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "metadataStoreId": { + "description": "The {metadatastore} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project}/locations/{location}/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataStores", + "request": { + "$ref": "GoogleCloudAiplatformV1MetadataStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "deprecated": true, + "description": "Deprecated: Field is no longer supported.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the MetadataStore to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a specific MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1MetadataStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MetadataStores for a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The Location whose MetadataStores should be listed. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataStores", + "response": { + "$ref": "GoogleCloudAiplatformV1ListMetadataStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "artifacts": { + "methods": { + "create": { + "description": "Creates an Artifact associated with a MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "artifactId": { + "description": "The {artifact} portion of the resource name with the format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/artifacts", + "request": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.artifacts.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the Artifact to delete. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a specific Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Artifact to retrieve. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Artifacts in the MetadataStore.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context(\"projects//locations//metadataStores//contexts/\")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a \" desc\" suffix; for example: \"foo desc, bar\". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/artifacts", + "response": { + "$ref": "GoogleCloudAiplatformV1ListArtifactsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a stored Artifact.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.metadataStores.artifacts.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "If set to true, and the Artifact is not found, a new Artifact is created.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of the Artifact.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. A FieldMask indicating which fields should be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Artifact" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Purges Artifacts.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The metadata store to purge Artifacts from. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/artifacts:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1PurgeArtifactsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "queryArtifactLineageSubgraph": { + "description": "Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}:queryArtifactLineageSubgraph", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph", + "parameterOrder": [ + "artifact" + ], + "parameters": { + "artifact": { + "description": "Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project}/locations/{location}/metadataStores/{metadatastore}/artifacts/{artifact}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = \"test\"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = \"2020-11-19T11:30:00-04:00\"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata.\"field:1\".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = \"test\" AND metadata.field1.bool_value = true`.", + "location": "query", + "type": "string" + }, + "maxHops": { + "description": "Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+artifact}:queryArtifactLineageSubgraph", + "response": { + "$ref": "GoogleCloudAiplatformV1LineageSubgraph" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.metadataStores.artifacts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataStores/[^/]+/artifacts/[^/]+$", "required": true, "type": "string" }, @@ -19778,9 +21394,385 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "notebookRuntimes": { + "methods": { + "assign": { + "description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.assign", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notebookRuntimes:assign", + "request": { + "$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists NotebookRuntimes in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", + "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/notebookRuntimes", + "response": { + "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Starts a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.start", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:start", + "request": { + "$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.stop", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:stop", + "request": { + "$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upgrade": { + "description": "Upgrades a NotebookRuntime.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:upgrade", + "request": { + "$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait", + "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", "parameterOrder": [ "name" ], @@ -19788,7 +21780,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -19811,28 +21803,56 @@ } } }, - "notebookRuntimes": { + "onlineEvaluators": { "methods": { - "assign": { - "description": "Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes:assign", + "activate": { + "description": "Activates an OnlineEvaluator.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:activate", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.assign", + "id": "aiplatform.projects.locations.onlineEvaluators.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the OnlineEvaluator to activate. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:activate", + "request": { + "$ref": "GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates an OnlineEvaluator in the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.onlineEvaluators.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project}/locations/{location}`", + "description": "Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/notebookRuntimes:assign", + "path": "v1/{+parent}/onlineEvaluators", "request": { - "$ref": "GoogleCloudAiplatformV1AssignNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1OnlineEvaluator" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -19842,18 +21862,18 @@ ] }, "delete": { - "description": "Deletes a NotebookRuntime.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "description": "Deletes an OnlineEvaluator.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimes.delete", + "id": "aiplatform.projects.locations.onlineEvaluators.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Required. The name of the OnlineEvaluator to delete. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true, "type": "string" } @@ -19867,130 +21887,102 @@ ] }, "get": { - "description": "Gets a NotebookRuntime.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}", + "description": "Gets details of an OnlineEvaluator.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.get", + "id": "aiplatform.projects.locations.onlineEvaluators.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1NotebookRuntime" + "$ref": "GoogleCloudAiplatformV1OnlineEvaluator" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists NotebookRuntimes in a Location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes", + "description": "Lists the OnlineEvaluators for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.list", + "id": "aiplatform.projects.locations.onlineEvaluators.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4`", + "description": "Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time>\"2026-01-01T00:00:00-04:00\"` where the timestamp is in RFC 3339 format) Based on aip.dev/160.", "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "description": "Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use \"desc\" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call.", + "description": "Optional. A token identifying a page of results the server should return. Based on aip.dev/158.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project}/locations/{location}`", + "description": "Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project}/locations/{location}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1/{+parent}/notebookRuntimes", + "path": "v1/{+parent}/onlineEvaluators", "response": { - "$ref": "GoogleCloudAiplatformV1ListNotebookRuntimesResponse" + "$ref": "GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "start": { - "description": "Starts a NotebookRuntime.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:start", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.start", + "patch": { + "description": "Updates the fields of an OnlineEvaluator.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.onlineEvaluators.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+name}:start", - "request": { - "$ref": "GoogleCloudAiplatformV1StartNotebookRuntimeRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stop": { - "description": "Stops a NotebookRuntime.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:stop", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.stop", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", - "required": true, + }, + "updateMask": { + "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", + "format": "google-fieldmask", + "location": "query", "type": "string" } }, - "path": "v1/{+name}:stop", + "path": "v1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1StopNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1OnlineEvaluator" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -19999,26 +21991,26 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "upgrade": { - "description": "Upgrades a NotebookRuntime.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}:upgrade", + "suspend": { + "description": "Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}:suspend", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.upgrade", + "id": "aiplatform.projects.locations.onlineEvaluators.suspend", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner.", + "description": "Required. The name of the OnlineEvaluator to suspend. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:upgrade", + "path": "v1/{+name}:suspend", "request": { - "$ref": "GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest" + "$ref": "GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -20033,9 +22025,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.cancel", + "id": "aiplatform.projects.locations.onlineEvaluators.operations.cancel", "parameterOrder": [ "name" ], @@ -20043,7 +22035,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20058,9 +22050,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.delete", + "id": "aiplatform.projects.locations.onlineEvaluators.operations.delete", "parameterOrder": [ "name" ], @@ -20068,7 +22060,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20083,9 +22075,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.get", + "id": "aiplatform.projects.locations.onlineEvaluators.operations.get", "parameterOrder": [ "name" ], @@ -20093,7 +22085,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20108,9 +22100,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.list", + "id": "aiplatform.projects.locations.onlineEvaluators.operations.list", "parameterOrder": [ "name" ], @@ -20123,7 +22115,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+$", "required": true, "type": "string" }, @@ -20154,9 +22146,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.notebookRuntimes.operations.wait", + "id": "aiplatform.projects.locations.onlineEvaluators.operations.wait", "parameterOrder": [ "name" ], @@ -20164,7 +22156,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -21430,6 +23422,84 @@ } } } + }, + "v1": { + "methods": { + "responses": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.v1.responses", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/v1/responses", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, + "resources": { + "responses": { + "methods": { + "compact": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.v1.responses.compact", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+endpoint}/v1/responses/compact", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } } } }, @@ -22688,6 +24758,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "ingestEvents": { + "description": "Ingests events for a Memory Bank.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories:ingestEvents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.memories.ingestEvents", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/memories:ingestEvents", + "request": { + "$ref": "GoogleCloudAiplatformV1IngestEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "List Memories.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/memories", @@ -22751,7 +24849,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -23889,6 +25987,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pause": { + "description": "Pauses the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes the specific SandboxEnvironment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "snapshot": { "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", @@ -24812,6 +26966,518 @@ } } }, + "semanticGovernancePolicies": { + "methods": { + "create": { + "description": "Creates a SemanticGovernancePolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "semanticGovernancePolicyId": { + "description": "Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/semanticGovernancePolicies", + "request": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicy" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SemanticGovernancePolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SemanticGovernancePolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SemanticGovernancePolicies in a given location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The list page size. If zero, a default page size of 10 is used.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/semanticGovernancePolicies", + "response": { + "$ref": "GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SemanticGovernancePolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Resource name of the SemanticGovernancePolicy.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicy" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "semanticGovernancePolicyEngine": { + "methods": { + "deprovision": { + "description": "Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:deprovision", + "request": { + "$ref": "GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "servingProfiles": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.servingProfiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.servingProfiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.servingProfiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.servingProfiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.servingProfiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "skills": { "resources": { "operations": { @@ -27940,9 +30606,321 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/trainingPipelines/{trainingPipelinesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "tuningJobs": { + "methods": { + "cancel": { + "description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a tuning job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1TuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists tuning jobs in a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rebaseTunedModel": { + "description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.trainingPipelines.operations.wait", + "id": "aiplatform.projects.locations.tuningJobs.operations.wait", "parameterOrder": [ "name" ], @@ -27950,7 +30928,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/trainingPipelines/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -27972,287 +30950,6 @@ } } } - }, - "tuningJobs": { - "methods": { - "cancel": { - "description": "Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the tuning job to cancel. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1CancelTuningJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the location to create the tuning job in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/tuningJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets a tuning job.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the tuning job to retrieve. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1TuningJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists tuning jobs in a location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/tuningJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1ListTuningJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "rebaseTunedModel": { - "description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the location in which to rebase the Model. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", - "request": { - "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.tuningJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.tuningJobs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } } } } @@ -30265,6 +32962,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pause": { + "description": "Pauses the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes the specific SandboxEnvironment.", + "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "snapshot": { "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "flatPath": "v1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", @@ -30729,6 +33482,326 @@ } } }, + "semanticGovernancePolicies": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.semanticGovernancePolicies.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.semanticGovernancePolicies.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.semanticGovernancePolicies.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.semanticGovernancePolicies.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.semanticGovernancePolicies.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^semanticGovernancePolicies/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "servingProfiles": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.servingProfiles.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.servingProfiles.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.servingProfiles.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/servingProfiles/{servingProfilesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.servingProfiles.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^servingProfiles/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default 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", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/servingProfiles/{servingProfilesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.servingProfiles.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^servingProfiles/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "skills": { "resources": { "operations": { @@ -32293,6 +35366,37 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -32357,27 +35461,42 @@ } } }, - "revision": "20260509", + "revision": "20260725", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { + "anchorLastFrame": { + "description": "Optional. If true, anchors the last frame in video generation by generating a custom border mask.", + "type": "boolean" + }, + "cfgScale": { + "description": "CFG scale for video-transform, perf-generation, a2v, video-textures models.", + "format": "float", + "type": "number" + }, "codec": { "description": "Optional. Video codec to use for output.", "enum": [ "VIDEO_CODEC_UNSPECIFIED", "VIDEO_CODEC_H264", - "VIDEO_CODEC_PRORES" + "VIDEO_CODEC_PRORES", + "VIDEO_CODEC_DNXHR" ], "enumDescriptions": [ + "", "", "", "" ], "type": "string" }, + "colorAlignment": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", + "description": "Optional. Color alignment configuration." + }, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -32385,6 +35504,18 @@ }, "type": "array" }, + "customParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary.", + "type": "object" + }, + "exrColorSpaceOverride": { + "description": "Optional. Colorspace to be used for all EXR inputs.", + "type": "string" + }, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -32398,6 +35529,14 @@ "format": "int32", "type": "integer" }, + "omniRewriter": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", + "description": "Optional. Omni Rewriter configuration." + }, + "originalRequestJson": { + "description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", + "type": "string" + }, "promptInputs": { "$ref": "CloudAiLargeModelsVisionPromptInputs", "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." @@ -32406,6 +35545,18 @@ "description": "Optional tag for tracking the source of this request. Allowed values: \"colab\", \"comfyui\", \"curl\", \"flowresearch\", \"vertexstudio\". Unrecognized tags are recorded as \"unknown\" in metrics. Tags do not affect video generation behavior. Up to 16 characters, ASCII alphanumeric, hyphens, and underscores only.", "type": "string" }, + "schedulingConfig": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", + "description": "Optional. Scheduling configuration." + }, + "seamless": { + "$ref": "CloudAiLargeModelsVisionSeamless", + "description": "Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation." + }, + "spatialAlignment": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", + "description": "Optional. Spatial alignment configuration." + }, "truncateInputVideo": { "description": "If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior.", "type": "boolean" @@ -32422,6 +35573,17 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig": { + "description": "Configuration for color alignment.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", + "properties": { + "enable": { + "description": "Optional. If true, enable alignment.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", "properties": { @@ -32437,6 +35599,45 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig": { + "description": "Configuration for Omni Rewriter.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", + "properties": { + "maxChunkDuration": { + "description": "Optional. Maximum duration of a chunk in seconds.", + "format": "float", + "type": "number" + }, + "rewriterInputFps": { + "description": "Optional. FPS used to generate gemini chunks for video inputs.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig": { + "description": "Configuration for spatial alignment.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", + "properties": { + "enable": { + "description": "Optional. If true, enable alignment.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig": { + "description": "Scheduling configuration for Veo Experimental.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", + "properties": { + "enableRetry": { + "description": "Optional. If true, enable retries on transient errors with default backoff.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionGenerateVideoRequestImage": { "description": "The image bytes or Cloud Storage URI to make the prediction on.", "id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", @@ -32810,6 +36011,24 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionSeamless": { + "id": "CloudAiLargeModelsVisionSeamless", + "properties": { + "loop": { + "description": "If true, the generated video will be loopable (seamless time looping).", + "type": "boolean" + }, + "tessellateHorizontal": { + "description": "If true, the generated video will be tessellatable as a horizontal tessellation.", + "type": "boolean" + }, + "tessellateVertical": { + "description": "If true, the generated video will be tessellatable as a vertical tessellation.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionSemanticFilterResponse": { "id": "CloudAiLargeModelsVisionSemanticFilterResponse", "properties": { @@ -32951,6 +36170,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata": { + "description": "Metadata for the ActivateOnlineEvaluator operation.", + "id": "GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Common part of operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest": { + "description": "Request message for ActivateOnlineEvaluator.", + "id": "GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1ActiveLearningConfig": { "description": "Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy.", "id": "GoogleCloudAiplatformV1ActiveLearningConfig", @@ -33054,6 +36290,187 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Agent": { + "description": "A Vertex agent contains instructions and configurations for the LLM to execute a certain task.", + "id": "GoogleCloudAiplatformV1Agent", + "properties": { + "base_agent": { + "description": "Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`", + "type": "string" + }, + "base_environment": { + "description": "Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.", + "type": "any" + }, + "created": { + "description": "Output only. The time the agent was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the agent.", + "type": "string" + }, + "id": { + "description": "Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The metadata for the agent.", + "type": "object" + }, + "name": { + "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "type": "string" + }, + "object": { + "description": "Output only. The object type of the resource. For agents, the value is `agent`.", + "readOnly": true, + "type": "string" + }, + "system_instruction": { + "description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", + "type": "string" + }, + "tools": { + "description": "Optional. The tools available to the agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1AgentTool" + }, + "type": "array" + }, + "updated": { + "description": "Output only. The time the agent was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AgentConfig": { + "description": "Represents configuration for an Agent.", + "id": "GoogleCloudAiplatformV1AgentConfig", + "properties": { + "agentId": { + "description": "Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map.", + "type": "string" + }, + "agentType": { + "description": "Optional. The type or class of the agent (e.g., \"LlmAgent\", \"RouterAgent\", \"ToolUseAgent\"). Useful for the autorater to understand the expected behavior of the agent.", + "type": "string" + }, + "description": { + "description": "Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly.", + "type": "string" + }, + "instruction": { + "description": "Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name} that will be resolved at runtime using the `AgentEvent.state_delta` field.", + "type": "string" + }, + "subAgents": { + "description": "Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tools": { + "description": "Optional. The list of tools available to this agent.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AgentData": { + "description": "Represents data specific to multi-turn agent evaluations.", + "id": "GoogleCloudAiplatformV1AgentData", + "properties": { + "agents": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1AgentConfig" + }, + "description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", + "type": "object" + }, + "turns": { + "description": "Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -> Agent Response).", + "items": { + "$ref": "GoogleCloudAiplatformV1ConversationTurn" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AgentEvent": { + "description": "Represents a single event in the execution trace.", + "id": "GoogleCloudAiplatformV1AgentEvent", + "properties": { + "activeTools": { + "description": "Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" + }, + "author": { + "description": "Required. The ID of the agent or entity that generated this event. Use \"user\" to denote events generated by the end-user.", + "type": "string" + }, + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The content of the event (e.g., text response, tool call, tool response)." + }, + "eventTime": { + "description": "Optional. The timestamp when the event occurred.", + "format": "google-datetime", + "type": "string" + }, + "stateDelta": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AgentTool": { + "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", + "id": "GoogleCloudAiplatformV1AgentTool", + "properties": { + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", + "type": "object" + }, + "name": { + "description": "Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.", + "type": "string" + }, + "type": { + "description": "Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`", + "type": "string" + }, + "url": { + "description": "Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1AggregationOutput": { "description": "The aggregation result for the entire dataset and all metrics.", "id": "GoogleCloudAiplatformV1AggregationOutput", @@ -33471,6 +36888,160 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1AudioResponseFormat": { + "description": "Configuration for audio-specific output formatting.", + "id": "GoogleCloudAiplatformV1AudioResponseFormat", + "properties": { + "bitRate": { + "description": "Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", + "format": "int32", + "type": "integer" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "mimeType": { + "description": "Optional. The MIME type of the audio output.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "AUDIO_MP3", + "AUDIO_OGG_OPUS", + "AUDIO_L16", + "AUDIO_WAV", + "AUDIO_ALAW", + "AUDIO_MULAW" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "MP3 audio format.", + "OGG Opus audio format.", + "Raw PCM (L16) audio format.", + "WAV audio format.", + "A-law audio format.", + "Mu-law audio format." + ], + "type": "string" + }, + "sampleRate": { + "description": "Optional. Sample rate for the generated audio in Hertz.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AudioTranscription": { + "description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label.", + "id": "GoogleCloudAiplatformV1AudioTranscription", + "properties": { + "speakerLabel": { + "description": "Optional. A label identifying the speaker of this audio segment (e.g. \"spk_1\", \"spk_2\"). Present when diarization is set.", + "type": "string" + }, + "text": { + "description": "Required. The transcription text of this audio segment.", + "type": "string" + }, + "words": { + "description": "Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.", + "items": { + "$ref": "GoogleCloudAiplatformV1AudioTranscriptionWordInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AudioTranscriptionConfig": { + "description": "Configuration for speech recognition (transcription).", + "id": "GoogleCloudAiplatformV1AudioTranscriptionConfig", + "properties": { + "adaptationPhrases": { + "deprecated": true, + "description": "Optional. A list of phrases to bias the ASR model towards.", + "items": { + "type": "string" + }, + "type": "array" + }, + "customVocabulary": { + "description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diarization": { + "description": "Optional. Configures speaker diarization.", + "type": "boolean" + }, + "languageAuto": { + "$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto", + "description": "Optional. The model will detect the language automatically." + }, + "languageHints": { + "$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints", + "description": "Optional. Specifies one or more languages in the audio." + }, + "wordTimestamp": { + "description": "Optional. Configures word-level timestamp generation.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto": { + "description": "Indicates the language of the audio should be automatically detected.", + "id": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints": { + "description": "Provides hints to the model about possible languages present in the audio.", + "id": "GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints", + "properties": { + "languageCodes": { + "description": "Required. BCP-47 language codes. At least one must be specified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1AudioTranscriptionWordInfo": { + "description": "Information about a single recognized word.", + "id": "GoogleCloudAiplatformV1AudioTranscriptionWordInfo", + "properties": { + "endOffset": { + "description": "Optional. End offset in time of the word relative to the start of the audio.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "Optional. Start offset in time of the word relative to the start of the audio.", + "format": "google-duration", + "type": "string" + }, + "word": { + "description": "Required. Transcript of the word.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1AugmentPromptRequest": { "description": "Request message for AugmentPrompt.", "id": "GoogleCloudAiplatformV1AugmentPromptRequest", @@ -33670,11 +37241,11 @@ "type": "object" }, "GoogleCloudAiplatformV1AutomaticResources": { - "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", + "description": "A description of resources that to large degree are decided by Agent Platform, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", "id": "GoogleCloudAiplatformV1AutomaticResources", "properties": { "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Agent Platform may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, @@ -33860,7 +37431,7 @@ "type": "integer" }, "startingReplicaCount": { - "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count", + "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Agent Platform decides starting number, not greater than max_replica_count", "format": "int32", "type": "integer" } @@ -34878,6 +38449,10 @@ "description": "Responses from model or agent.", "id": "GoogleCloudAiplatformV1CandidateResponse", "properties": { + "agentData": { + "$ref": "GoogleCloudAiplatformV1AgentData", + "description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation." + }, "candidate": { "description": "Required. The name of the candidate that produced the response.", "type": "string" @@ -34910,6 +38485,11 @@ "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", "type": "string" }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error while evaluating the candidate for the metric.", + "readOnly": true + }, "explanation": { "description": "Optional. The explanation for the metric.", "type": "string" @@ -35106,10 +38686,59 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CloudLoggingConfig": { + "description": "Specifies configuration for exporting evaluation results to Cloud Logging.", + "id": "GoogleCloudAiplatformV1CloudLoggingConfig", + "properties": { + "project": { + "description": "Optional. Google Cloud project to write logs to. Defaults to the request project.", + "type": "string" + }, + "resourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location.", + "type": "object" + }, + "resourceType": { + "description": "Optional. MonitoredResource type. Defaults to \"global\" if unspecified.", + "type": "string" + }, + "tracingContext": { + "$ref": "GoogleCloudAiplatformV1CloudLoggingConfigTracingContext", + "description": "Optional. Tracing context for the evaluation run." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1CloudLoggingConfigTracingContext": { + "description": "Tracing context for Observability correlation.", + "id": "GoogleCloudAiplatformV1CloudLoggingConfigTracingContext", + "properties": { + "conversationId": { + "description": "Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes.", + "type": "string" + }, + "spanId": { + "description": "Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated.", + "type": "string" + }, + "traceId": { + "description": "Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CodeExecutionResult": { "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1CodeExecutionResult", "properties": { + "id": { + "description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", + "type": "string" + }, "outcome": { "description": "Required. Outcome of the code execution.", "enum": [ @@ -35560,6 +39189,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ConversationTurn": { + "description": "Represents a single turn/invocation in the conversation.", + "id": "GoogleCloudAiplatformV1ConversationTurn", + "properties": { + "events": { + "description": "Optional. The list of events that occurred during this turn.", + "items": { + "$ref": "GoogleCloudAiplatformV1AgentEvent" + }, + "type": "array" + }, + "turnId": { + "description": "Optional. A unique identifier for the turn. Useful for referencing specific turns across systems.", + "type": "string" + }, + "turnIndex": { + "description": "Required. The 0-based index of the turn in the conversation sequence.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CopyModelOperationMetadata": { "description": "Details of ModelService.CopyModel operation.", "id": "GoogleCloudAiplatformV1CopyModelOperationMetadata", @@ -36018,6 +39670,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata": { + "description": "Metadata for the CreateOnlineEvaluator operation.", + "id": "GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Common part of operation metadata." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata": { "description": "Details of operations that perform create PersistentResource.", "id": "GoogleCloudAiplatformV1CreatePersistentResourceOperationMetadata", @@ -36063,6 +39726,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreateServingProfileOperationMetadata": { + "description": "Runtime operation metadata for ServingProfileService.CreateServingProfile.", + "id": "GoogleCloudAiplatformV1CreateServingProfileOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Output only. The standard operation metadata for Vertex AI.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata": { "description": "Runtime operation information for SpecialistPoolService.CreateSpecialistPool.", "id": "GoogleCloudAiplatformV1CreateSpecialistPoolOperationMetadata", @@ -36837,7 +40512,7 @@ "description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Agent Platform CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, @@ -36979,6 +40654,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata": { + "description": "Metadata for the DeleteOnlineEvaluator operation.", + "id": "GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Generic operation metadata." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DeleteOperationMetadata": { "description": "Details of operations that perform deletes of any entities.", "id": "GoogleCloudAiplatformV1DeleteOperationMetadata", @@ -37587,6 +41273,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest": { + "description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.", + "id": "GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest", + "properties": { + "force": { + "description": "Optional. If true, the operation bypass checks on current state and force the deprovisioning operation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DestinationFeatureSetting": { "id": "GoogleCloudAiplatformV1DestinationFeatureSetting", "properties": { @@ -38282,7 +41979,7 @@ "properties": { "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1AutoraterConfig", - "description": "Optional. Autorater config used for evaluation." + "description": "Optional. Autorater config used for evaluation. Not applicable for predefined metrics (PredefinedMetricSpec); the server uses its own model configuration for predefined metrics and this field is ignored." }, "bleuInput": { "$ref": "GoogleCloudAiplatformV1BleuInput", @@ -39033,6 +42730,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluationMetric": { + "description": "EvaluationMetric is a resource that represents a reusable metric configuration.", + "id": "GoogleCloudAiplatformV1EvaluationMetric", + "properties": { + "createTime": { + "description": "Output only. The time when the EvaluationMetric was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A description of the EvaluationMetric.", + "type": "string" + }, + "displayName": { + "description": "Required. The user-friendly display name for the EvaluationMetric.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key." + }, + "gcsUri": { + "description": "Optional. The Google Cloud Storage URI that stores the metric specification..", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the evaluation metric.", + "type": "object" + }, + "metric": { + "$ref": "GoogleCloudAiplatformV1Metric", + "description": "Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported." + }, + "name": { + "description": "Identifier. The resource name of the EvaluationMetric. Format: `projects/{project}/locations/{location}/evaluationMetrics/{evaluation_metric}`", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the EvaluationMetric was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1EvaluationParserConfig": { "description": "Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters.", "id": "GoogleCloudAiplatformV1EvaluationParserConfig", @@ -39059,6 +42806,10 @@ "description": "Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations.", "id": "GoogleCloudAiplatformV1EvaluationPrompt", "properties": { + "agentData": { + "$ref": "GoogleCloudAiplatformV1AgentData", + "description": "Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping." + }, "promptTemplateData": { "$ref": "GoogleCloudAiplatformV1EvaluationPromptPromptTemplateData", "description": "Prompt template data." @@ -39067,6 +42818,10 @@ "description": "Text prompt.", "type": "string" }, + "userScenario": { + "$ref": "GoogleCloudAiplatformV1EvaluationPromptUserScenario", + "description": "Optional. The generated user scenario used to drive multi-turn agent running results." + }, "value": { "description": "Fields and values that can be used to populate the prompt template.", "type": "any" @@ -39088,6 +42843,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1EvaluationPromptUserScenario": { + "description": "User scenario to help simulate multi-turn agent running results.", + "id": "GoogleCloudAiplatformV1EvaluationPromptUserScenario", + "properties": { + "conversationPlan": { + "description": "Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset.", + "type": "string" + }, + "startingPrompt": { + "description": "Required. The prompt that starts the conversation between the simulated user and the agent under test.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1EvaluationRequest": { "description": "A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`.", "id": "GoogleCloudAiplatformV1EvaluationRequest", @@ -39303,6 +43073,10 @@ "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, + "cloudLoggingConfig": { + "$ref": "GoogleCloudAiplatformV1CloudLoggingConfig", + "description": "Optional. Configuration for exporting evaluation results to Cloud Logging." + }, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "items": { @@ -39310,6 +43084,13 @@ }, "type": "array" }, + "lossAnalysisConfig": { + "description": "Optional. Specifications for loss analysis. Each config can be specified for one metric.", + "items": { + "$ref": "GoogleCloudAiplatformV1LossAnalysisConfig" + }, + "type": "array" + }, "metrics": { "description": "Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set.", "items": { @@ -39393,6 +43174,13 @@ "$ref": "GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig", "description": "Optional. Agent run config." }, + "agents": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1AgentConfig" + }, + "description": "Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", + "type": "object" + }, "generationConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfig", "description": "Optional. Generation config." @@ -39405,6 +43193,10 @@ "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", "format": "int32", "type": "integer" + }, + "promptTemplate": { + "$ref": "GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate", + "description": "Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used." } }, "type": "object" @@ -39685,6 +43477,13 @@ "description": "EvaluationSet is a collection of related EvaluationItems that are evaluated together.", "id": "GoogleCloudAiplatformV1EvaluationSet", "properties": { + "agentConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1AgentConfig" + }, + "description": "Optional. Static configurations for each agent associated with the items in this set. Key: `agent_id` (matches the `author` field in `events`). Value: The static configuration of the agent.", + "type": "object" + }, "createTime": { "description": "Output only. Timestamp when this item was created.", "format": "google-datetime", @@ -39695,6 +43494,10 @@ "description": "Required. The display name of the EvaluationSet.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key." + }, "evaluationItems": { "description": "Required. The EvaluationItems that are part of this dataset.", "items": { @@ -40044,6 +43847,10 @@ "description": "Required. The code to be executed.", "type": "string" }, + "id": { + "description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", + "type": "string" + }, "language": { "description": "Required. Programming language of the `code`.", "enum": [ @@ -42697,6 +46504,10 @@ "description": "Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details.", "type": "object" }, + "id": { + "description": "Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`.", + "type": "string" + }, "name": { "description": "Optional. The name of the function to call. Matches FunctionDeclaration.name.", "type": "string" @@ -42800,6 +46611,10 @@ "description": "The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction.", "id": "GoogleCloudAiplatformV1FunctionResponse", "properties": { + "id": { + "description": "Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`.", + "type": "string" + }, "name": { "description": "Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.", "type": "string" @@ -42892,6 +46707,68 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GatewayConfig": { + "description": "Configuration for a single gateway.", + "id": "GoogleCloudAiplatformV1GatewayConfig", + "properties": { + "allowedProjects": { + "description": "Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the \"decoupled\" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dnsRecord": { + "description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", + "readOnly": true, + "type": "string" + }, + "dnsZoneName": { + "description": "Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.", + "type": "string" + }, + "ipAddress": { + "description": "Output only. The private IP address of the PSC endpoint.", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "pscEndpoint": { + "description": "Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the Gateway configuration.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "ACTIVE", + "DEPROVISIONING", + "INACTIVE", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The Gateway is being provisioned.", + "The Gateway is active and ready to use.", + "The Gateway is being de-provisioned.", + "The Gateway is inactive.", + "The Gateway failed to be provisioned." + ], + "readOnly": true, + "type": "string" + }, + "subnetwork": { + "description": "Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1GcsDestination", @@ -43289,6 +47166,42 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenerateLossClustersRequest": { + "description": "Request message for EvaluationAnalyticsService.GenerateLossClusters.", + "id": "GoogleCloudAiplatformV1GenerateLossClustersRequest", + "properties": { + "configs": { + "description": "Required. Configuration for the analysis algorithm. Analysis for multiple metrics and multiple candidates could be specified.", + "items": { + "$ref": "GoogleCloudAiplatformV1LossAnalysisConfig" + }, + "type": "array" + }, + "evaluationSet": { + "description": "Reference to a persisted EvaluationSet. The service will read items from this set.", + "type": "string" + }, + "inlineResults": { + "$ref": "GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList", + "description": "Inline evaluation results. Useful for ephemeral analysis in notebooks/SDKs where data isn't persisted." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList": { + "description": "A wrapper to allow providing a list of items inline.", + "id": "GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList", + "properties": { + "evaluationResults": { + "description": "Required. The list of evaluation results to analyze.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenerateMemoriesRequest": { "description": "Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB.", "id": "GoogleCloudAiplatformV1GenerateMemoriesRequest", @@ -43492,6 +47405,46 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenerateUserScenariosRequest": { + "description": "Request message for DataFoundryService.GenerateUserScenarios.", + "id": "GoogleCloudAiplatformV1GenerateUserScenariosRequest", + "properties": { + "agents": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1AgentConfig" + }, + "description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent.", + "type": "object" + }, + "allowCrossRegionModel": { + "description": "Optional. Allows the scenario generation to use cross region models. When this flag is set, the service may route traffic to other regions if a model is unavailable in the current region (e.g., to a `global` endpoint). If a fully-qualified model endpoint resource name with a different region than the request location is provided elsewhere in the request, this flag must be set to true or the request will fail.", + "type": "boolean" + }, + "rootAgentId": { + "description": "Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent.", + "type": "string" + }, + "userScenarioGenerationConfig": { + "$ref": "GoogleCloudAiplatformV1UserScenarioGenerationConfig", + "description": "Required. Configuration for generating user scenarios." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerateUserScenariosResponse": { + "description": "Response message for DataFoundryService.GenerateUserScenarios.", + "id": "GoogleCloudAiplatformV1GenerateUserScenariosResponse", + "properties": { + "userScenarios": { + "description": "The generated user scenarios used to simulate multi-turn agent running results and agent evaluation.", + "items": { + "$ref": "GoogleCloudAiplatformV1UserScenario" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenerateVideoResponse": { "description": "Generate video response.", "id": "GoogleCloudAiplatformV1GenerateVideoResponse", @@ -43553,6 +47506,10 @@ "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" }, + "audioTranscriptionConfig": { + "$ref": "GoogleCloudAiplatformV1AudioTranscriptionConfig", + "description": "Optional. Config for audio transcription (speech recognition)." + }, "candidateCount": { "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", @@ -43569,7 +47526,8 @@ }, "imageConfig": { "$ref": "GoogleCloudAiplatformV1ImageConfig", - "description": "Optional. Config for image generation features." + "deprecated": true, + "description": "Optional. Config for image generation features. Deprecated: Use `response_format.image` instead." }, "logprobs": { "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.", @@ -43602,8 +47560,16 @@ "format": "float", "type": "number" }, + "responseFormat": { + "description": "Optional. New response format field for the model to configure output formatting and delivery.", + "items": { + "$ref": "GoogleCloudAiplatformV1ResponseFormat" + }, + "type": "array" + }, "responseJsonSchema": { - "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", + "deprecated": true, + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.", "type": "any" }, "responseLogprobs": { @@ -43611,7 +47577,8 @@ "type": "boolean" }, "responseMimeType": { - "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.", + "deprecated": true, + "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. Deprecated: Use `response_format` instead.", "type": "string" }, "responseModalities": { @@ -43637,7 +47604,8 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1Schema", - "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`." + "deprecated": true, + "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`. Deprecated: Use `response_format` instead." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", @@ -43846,12 +47814,44 @@ "id": "GoogleCloudAiplatformV1GoogleMaps", "properties": { "enableWidget": { - "description": "Optional. If true, include the widget context token in the response.", + "deprecated": true, + "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.", "type": "boolean" + }, + "groundingTypes": { + "$ref": "GoogleCloudAiplatformV1GoogleMapsGroundingTypes", + "description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GoogleMapsGroundingTypes": { + "description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", + "id": "GoogleCloudAiplatformV1GoogleMapsGroundingTypes", + "properties": { + "places": { + "$ref": "GoogleCloudAiplatformV1GoogleMapsPlaces", + "description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified." + }, + "routing": { + "$ref": "GoogleCloudAiplatformV1GoogleMapsRouting", + "description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." } }, "type": "object" }, + "GoogleCloudAiplatformV1GoogleMapsPlaces": { + "description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.", + "id": "GoogleCloudAiplatformV1GoogleMapsPlaces", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1GoogleMapsRouting": { + "description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", + "id": "GoogleCloudAiplatformV1GoogleMapsRouting", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1GoogleSearchRetrieval", @@ -44113,7 +48113,8 @@ "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { - "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.", + "deprecated": true, + "description": "Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. 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" }, @@ -44143,6 +48144,13 @@ "description": "Optional. Output only. Metadata related to the retrieval grounding source.", "readOnly": true }, + "retrievalQueries": { + "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" + }, + "type": "array" + }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "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." @@ -44424,6 +48432,95 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ImageResponseFormat": { + "description": "Configuration for image-specific output formatting.", + "id": "GoogleCloudAiplatformV1ImageResponseFormat", + "properties": { + "aspectRatio": { + "description": "Optional. The aspect ratio for the image output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_ONE_BY_ONE", + "ASPECT_RATIO_TWO_BY_THREE", + "ASPECT_RATIO_THREE_BY_TWO", + "ASPECT_RATIO_THREE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_THREE", + "ASPECT_RATIO_FOUR_BY_FIVE", + "ASPECT_RATIO_FIVE_BY_FOUR", + "ASPECT_RATIO_NINE_BY_SIXTEEN", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_TWENTY_ONE_BY_NINE", + "ASPECT_RATIO_ONE_BY_EIGHT", + "ASPECT_RATIO_EIGHT_BY_ONE", + "ASPECT_RATIO_ONE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_ONE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "1:1 aspect ratio.", + "2:3 aspect ratio.", + "3:2 aspect ratio.", + "3:4 aspect ratio.", + "4:3 aspect ratio.", + "4:5 aspect ratio.", + "5:4 aspect ratio.", + "9:16 aspect ratio.", + "16:9 aspect ratio.", + "21:9 aspect ratio.", + "1:8 aspect ratio.", + "8:1 aspect ratio.", + "1:4 aspect ratio.", + "4:1 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "imageSize": { + "description": "Optional. The size of the image output.", + "enum": [ + "IMAGE_SIZE_UNSPECIFIED", + "IMAGE_SIZE_FIVE_TWELVE", + "IMAGE_SIZE_ONE_K", + "IMAGE_SIZE_TWO_K", + "IMAGE_SIZE_FOUR_K" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "512px image size.", + "1K image size.", + "2K image size.", + "4K image size." + ], + "type": "string" + }, + "mimeType": { + "description": "Optional. The MIME type of the image output.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "IMAGE_JPEG" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JPEG image format." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ImportDataConfig": { "description": "Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.", "id": "GoogleCloudAiplatformV1ImportDataConfig", @@ -44484,6 +48581,150 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequest": { + "description": "Request message for EvaluationManagementService.ImportEvaluationSet.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequest", + "properties": { + "agentEngineSource": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource", + "description": "Source for loading Agent Engine sessions." + }, + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1BigQueryRequestSet", + "description": "BigQuery source with column mappings." + }, + "cloudTraceSource": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource", + "description": "Source for loading data directly from Cloud Trace." + }, + "evaluationSet": { + "$ref": "GoogleCloudAiplatformV1EvaluationSet", + "description": "Required. The EvaluationSet to create. Used to specify 'display_name' and 'metadata'. The 'evaluation_items' field is ignored and populated by the import process." + }, + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Required. The Cloud Storage location where the resulting EvaluationItem payloads will be stored." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource", + "description": "Google Cloud Storage location." + }, + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource", + "description": "Inline source for small payloads (< 4MB)." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource": { + "description": "Source for loading Agent Engine sessions.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource", + "properties": { + "location": { + "description": "Required. Location for the Agent Engine sessions.", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID for the Agent Engine sessions.", + "type": "string" + }, + "reasoningEngineId": { + "description": "Required. Reasoning Engine ID for the Agent Engine sessions.", + "type": "string" + }, + "sessionIds": { + "description": "Required. Session IDs for the Agent Engine sessions to retrieve.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource": { + "description": "Source for loading traces directly from Cloud Trace.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource", + "properties": { + "projectId": { + "description": "Required. Project ID for the Cloud Trace.", + "type": "string" + }, + "sessionIds": { + "description": "Optional. Session IDs to import traces for. If both trace_ids and session_ids are specified, the union of the two will be imported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "traceIds": { + "description": "Optional. Trace IDs to import.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource": { + "description": "Source for loading data from Cloud Storage.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource", + "properties": { + "gcsUri": { + "description": "Required. The Cloud Storage location of the input data.", + "type": "string" + }, + "importSchemaConfig": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig", + "description": "Required. Schema configuration for the input data." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig": { + "description": "Configuration for the input data format.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig", + "properties": { + "dataFormat": { + "description": "Required. The format of the input data.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "OTEL_PROTO", + "OTEL_JSON", + "JSONL" + ], + "enumDescriptions": [ + "Unspecified data format.", + "OpenTelemetry Protobuf format (e.g. TracesData).", + "OpenTelemetry JSON format.", + "JSONL format mapping directly to EvaluationItem schema." + ], + "type": "string" + }, + "dataFormatVersion": { + "description": "Optional. Version of the data format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource": { + "description": "Wrapper for inline data.", + "id": "GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource", + "properties": { + "content": { + "description": "Required. The content of the inline data.", + "format": "byte", + "type": "string" + }, + "importSchemaConfig": { + "$ref": "GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig", + "description": "Required. Schema configuration for the inline data." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata": { "description": "Details of operations that perform import Feature values.", "id": "GoogleCloudAiplatformV1ImportFeatureValuesOperationMetadata", @@ -45090,6 +49331,114 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1IngestEventsRequest": { + "description": "Request message for MemoryBankService.IngestEvents.", + "id": "GoogleCloudAiplatformV1IngestEventsRequest", + "properties": { + "directContentsSource": { + "$ref": "GoogleCloudAiplatformV1IngestionDirectContentsSource", + "description": "Ingest events directly from the request." + }, + "disableMemoryRevisions": { + "description": "Optional. If true, no revisions will be created for this request.", + "type": "boolean" + }, + "forceFlush": { + "description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", + "type": "boolean" + }, + "generationTriggerConfig": { + "$ref": "GoogleCloudAiplatformV1MemoryGenerationTriggerConfig", + "description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately." + }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", + "type": "object" + }, + "metadataMergeStrategy": { + "description": "Optional. The strategy to use when applying metadata to existing memories.", + "enum": [ + "METADATA_MERGE_STRATEGY_UNSPECIFIED", + "OVERWRITE", + "MERGE", + "REQUIRE_EXACT_MATCH" + ], + "enumDescriptions": [ + "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", + "Replace the metadata of the updated memories with the new metadata.", + "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", + "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." + ], + "type": "string" + }, + "revisionExpireTime": { + "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", + "format": "google-datetime", + "type": "string" + }, + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", + "type": "object" + }, + "revisionTtl": { + "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, + "scope": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'.", + "type": "object" + }, + "streamId": { + "description": "Optional. The ID of the stream to ingest events into. If not provided, a new one will be created.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IngestionDirectContentsSource": { + "description": "Ingest events directly from the request.", + "id": "GoogleCloudAiplatformV1IngestionDirectContentsSource", + "properties": { + "events": { + "description": "Required. The events to ingest.", + "items": { + "$ref": "GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent": { + "description": "A single event to ingest.", + "id": "GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Required. The content of the event." + }, + "eventId": { + "description": "Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated.", + "type": "string" + }, + "eventTime": { + "description": "Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1InputDataConfig": { "description": "Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model.", "id": "GoogleCloudAiplatformV1InputDataConfig", @@ -45382,6 +49731,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListAgentsResponse": { + "description": "Response message for AgentService.ListAgents.", + "id": "GoogleCloudAiplatformV1ListAgentsResponse", + "properties": { + "agents": { + "description": "The agents matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1Agent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListAnnotationsResponse": { "description": "Response message for DatasetService.ListAnnotations.", "id": "GoogleCloudAiplatformV1ListAnnotationsResponse", @@ -45634,6 +50001,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListEvaluationMetricsResponse": { + "description": "Response message for EvaluationMetricService.ListEvaluationMetrics.", + "id": "GoogleCloudAiplatformV1ListEvaluationMetricsResponse", + "properties": { + "evaluationMetrics": { + "description": "List of EvaluationMetrics in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1EvaluationMetric" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListEvaluationRunsResponse": { "description": "Response message for EvaluationManagementService.ListEvaluationRuns.", "id": "GoogleCloudAiplatformV1ListEvaluationRunsResponse", @@ -46138,6 +50523,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse": { + "description": "Response message for ListOnlineEvaluators.", + "id": "GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + }, + "onlineEvaluators": { + "description": "A list of OnlineEvaluators matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluator" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListOptimalTrialsRequest": { "description": "Request message for VizierService.ListOptimalTrials.", "id": "GoogleCloudAiplatformV1ListOptimalTrialsRequest", @@ -46337,6 +50740,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse": { + "description": "Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies.", + "id": "GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page.", + "type": "string" + }, + "semanticGovernancePolicies": { + "description": "The list of SemanticGovernancePolicies.", + "items": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListSessionsResponse": { "description": "Response message for SessionService.ListSessions.", "id": "GoogleCloudAiplatformV1ListSessionsResponse", @@ -46584,6 +51005,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1LossAnalysisConfig": { + "description": "Configuration for the loss analysis job.", + "id": "GoogleCloudAiplatformV1LossAnalysisConfig", + "properties": { + "candidate": { + "description": "Required. The candidate model/agent to analyze (e.g., \"gemini-3.0-pro\"). This targets the specific CandidateResult within the EvaluationResult.", + "type": "string" + }, + "metric": { + "description": "Required. The metric to analyze (e.g., \"tool_use_quality\"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1LustreMount": { "description": "Represents a mount configuration for Lustre file system.", "id": "GoogleCloudAiplatformV1LustreMount", @@ -46612,7 +51048,7 @@ "id": "GoogleCloudAiplatformV1MachineSpec", "properties": { "acceleratorCount": { - "description": "The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.", + "description": "The number of accelerators to attach to the machine. For [accelerator optimized machine types](https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Agent Platform co-schedules the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Agent Platform co-schedules 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.", "format": "int32", "type": "integer" }, @@ -46688,7 +51124,7 @@ "type": "string" }, "machineType": { - "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", + "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" }, "reservationAffinity": { @@ -47092,6 +51528,11 @@ "description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", "format": "google-duration", "type": "string" + }, + "overlapEventCount": { + "description": "Optional. Re-include the last N already-processed events in the next window.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -47896,7 +52337,7 @@ }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1ModelContainerSpec", - "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." + "description": "The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." }, "createTime": { "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", @@ -49733,7 +54174,8 @@ "INVALID_SPARSE_EMBEDDING", "INVALID_EMBEDDING", "INVALID_EMBEDDING_METADATA", - "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT" + "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT", + "DUPLICATE_ID" ], "enumDescriptions": [ "Default, shall not be used.", @@ -49755,7 +54197,8 @@ "Invalid sparse embedding.", "Invalid dense embedding.", "Invalid embedding metadata.", - "Embedding metadata exceeds size limit." + "Embedding metadata exceeds size limit.", + "Multiple input records share the same datapoint id. The input conversion pipeline performs non-deterministic last-write-wins de-duplication and emits one error per duplicated id." ], "type": "string" }, @@ -50017,6 +54460,29 @@ "persistentDiskSpec": { "$ref": "GoogleCloudAiplatformV1PersistentDiskSpec", "description": "The specification of a persistent disk to attach for the execution job." + }, + "shieldedInstanceConfig": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", + "description": "Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig": { + "description": "A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Optional. Whether the VM instance has integrity monitoring enabled.", + "type": "boolean" + }, + "enableSecureBoot": { + "description": "Optional. Whether the VM instance has Secure Boot enabled. Disabled by default.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Optional. Whether the VM instance has vTPM enabled.", + "type": "boolean" } }, "type": "object" @@ -50066,7 +54532,50 @@ "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime": { "description": "Configuration for a Workbench Instances-based environment.", "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime", - "properties": {}, + "properties": { + "customContainerImage": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage", + "description": "A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM." + }, + "vmImage": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage", + "description": "A specific Compute Engine VM image to run the notebook on." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage": { + "description": "The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage", + "properties": { + "repository": { + "description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`.", + "type": "string" + }, + "tag": { + "description": "Optional. The tag of the container image. If unset, defaults to `latest`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage": { + "description": "The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage", + "properties": { + "family": { + "description": "Use this VM image family to find the image; the newest image in this family is used.", + "type": "string" + }, + "name": { + "description": "Use this VM image name to find the image.", + "type": "string" + }, + "project": { + "description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`.", + "type": "string" + } + }, "type": "object" }, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { @@ -50453,6 +54962,216 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1OnlineEvaluator": { + "description": "An OnlineEvaluator contains the configuration for an Online Evaluation.", + "id": "GoogleCloudAiplatformV1OnlineEvaluator", + "properties": { + "agentResource": { + "description": "Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed.", + "type": "string" + }, + "cloudObservability": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability", + "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging)." + }, + "config": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorConfig", + "description": "Required. Configuration for the OnlineEvaluator." + }, + "createTime": { + "description": "Output only. Timestamp when the OnlineEvaluator was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + }, + "metricSources": { + "description": "Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25.", + "items": { + "$ref": "GoogleCloudAiplatformV1MetricSource" + }, + "type": "array" + }, + "name": { + "description": "Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the OnlineEvaluator.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "SUSPENDED", + "FAILED", + "WARNING" + ], + "enumDescriptions": [ + "Default value.", + "Indicates that the OnlineEvaluator is active.", + "Indicates that the OnlineEvaluator is suspended. In this state, the OnlineEvaluator will not evaluate any samples.", + "Indicates that the OnlineEvaluator is in a failed state. This can happen if, for example, the `log_view` or `trace_view` set on the `CloudObservability` does not exist.", + "Indicates that the OnlineEvaluator is in a warning state. This can happen if, for example, some of the metrics in the `metric_sources` are invalid. Evaluation will still run with the remaining valid metrics." + ], + "readOnly": true, + "type": "string" + }, + "stateDetails": { + "description": "Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure.", + "items": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorStateDetails" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. Timestamp when the OnlineEvaluator was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability": { + "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging).", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability", + "properties": { + "logView": { + "description": "Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used.", + "type": "string" + }, + "openTelemetry": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry", + "description": "Data source follows OpenTelemetry convention." + }, + "traceScope": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope", + "description": "Scope online evaluation to single traces." + }, + "traceView": { + "description": "Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used. NOTE: This field is not supported yet and will be ignored if set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate": { + "description": "Defines a predicate for filtering based on a numeric value.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate", + "properties": { + "comparisonOperator": { + "description": "Required. The comparison operator to apply.", + "enum": [ + "COMPARISON_OPERATOR_UNSPECIFIED", + "LESS", + "LESS_OR_EQUAL", + "EQUAL", + "NOT_EQUAL", + "GREATER_OR_EQUAL", + "GREATER" + ], + "enumDescriptions": [ + "Unspecified comparison operator. This value should not be used.", + "Less than.", + "Less than or equal to.", + "Equal to.", + "Not equal to.", + "Greater than or equal to.", + "Greater than." + ], + "type": "string" + }, + "value": { + "description": "Required. The value to compare against.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry": { + "description": "Configuration for data source following OpenTelemetry.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry", + "properties": { + "semconvVersion": { + "description": "Required. Defines which version OTel Semantic Convention the data follows. Can be \"1.39.0\" or newer.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope": { + "description": "If chosen, the online evaluator will evaluate single traces matching specified `filter`.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope", + "properties": { + "filter": { + "description": "Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10.", + "items": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate": { + "description": "Defines a single filter predicate.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate", + "properties": { + "duration": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate", + "description": "Filter on the duration of a trace (in seconds)." + }, + "totalTokenUsage": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate", + "description": "Filter on the total token usage within a trace." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorConfig": { + "description": "Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorConfig", + "properties": { + "maxEvaluatedSamplesPerRun": { + "description": "Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded.", + "format": "int64", + "type": "string" + }, + "randomSampling": { + "$ref": "GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling", + "description": "Random sampling method." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling": { + "description": "Configuration for random sampling.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling", + "properties": { + "percentage": { + "description": "Required. The percentage of traces to sample for evaluation. Must be an integer between `1` and `100`.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1OnlineEvaluatorStateDetails": { + "description": "Contains additional information about the state of the OnlineEvaluator.", + "id": "GoogleCloudAiplatformV1OnlineEvaluatorStateDetails", + "properties": { + "message": { + "description": "Output only. Human-readable message describing the state of the OnlineEvaluator.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1OutputConfig": { "description": "Config for evaluation output.", "id": "GoogleCloudAiplatformV1OutputConfig", @@ -50835,6 +55554,10 @@ "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": { + "audioTranscription": { + "$ref": "GoogleCloudAiplatformV1AudioTranscription", + "description": "Optional. Audio (input or output) transcription. This is only set when this Part contains audio data." + }, "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1CodeExecutionResult", "description": "Optional. The result of executing the ExecutableCode." @@ -50952,6 +55675,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentService.PauseSandboxEnvironment.", + "id": "GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1PauseScheduleRequest": { "description": "Request message for ScheduleService.PauseSchedule.", "id": "GoogleCloudAiplatformV1PauseScheduleRequest", @@ -50959,7 +55688,7 @@ "type": "object" }, "GoogleCloudAiplatformV1PersistentDiskSpec": { - "description": "Represents the spec of persistent disk options.", + "description": "Represents the spec of persistent disk and hyperdisk options.", "id": "GoogleCloudAiplatformV1PersistentDiskSpec", "properties": { "diskSizeGb": { @@ -50968,7 +55697,7 @@ "type": "string" }, "diskType": { - "description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk)", + "description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk) \"hyperdisk-balanced\" (Hyperdisk Balanced) \"hyperdisk-extreme\" (Hyperdisk Extreme) \"hyperdisk-balanced-high-availability\" (Hyperdisk Balanced High Availability) \"hyperdisk-ml\" (Hyperdisk ML) \"hyperdisk-throughput\" (Hyperdisk Throughput)", "type": "string" } }, @@ -54269,6 +58998,10 @@ "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, + "buildSpec": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", + "description": "Optional. Configuration for building container image." + }, "classMethods": { "description": "Optional. Declarations for object class methods in OpenAPI specification format.", "items": { @@ -54322,6 +59055,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec": { + "description": "Specification for building container image.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", + "properties": { + "serviceAccount": { + "description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", + "type": "string" + }, + "workerPool": { + "description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec": { "description": "Specification for deploying from a container image.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecContainerSpec", @@ -54329,6 +59077,11 @@ "imageUri": { "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", "type": "string" + }, + "port": { + "description": "Optional. The port the container listens on. Defaults to 8080 if unset.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -54337,6 +59090,10 @@ "description": "The specification of a Reasoning Engine deployment.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec", "properties": { + "agentGatewayConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig", + "description": "Optional. Agent Gateway configuration for the Reasoning Engine deployment." + }, "containerConcurrency": { "description": "Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9.", "format": "int32", @@ -54384,6 +59141,43 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig": { + "description": "Agent Gateway configuration for a Reasoning Engine deployment.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig", + "properties": { + "agentToAnywhereConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig", + "description": "Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway." + }, + "clientToAgentConfig": { + "$ref": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig", + "description": "Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig": { + "description": "Configuration for traffic originating from a Reasoning Engine.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig", + "properties": { + "agentGateway": { + "description": "Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig": { + "description": "Configuration for traffic targeting a Reasoning Engine.", + "id": "GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig", + "properties": { + "agentGateway": { + "description": "Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project}/locations/{location}/agentGateways/{agent_gateway}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec": { "description": "User-provided package specification, containing pickled object and package requirements.", "id": "GoogleCloudAiplatformV1ReasoningEngineSpecPackageSpec", @@ -54771,6 +59565,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ResponseFormat": { + "description": "Configuration for the model to configure output formatting and delivery.", + "id": "GoogleCloudAiplatformV1ResponseFormat", + "properties": { + "audio": { + "$ref": "GoogleCloudAiplatformV1AudioResponseFormat", + "description": "Audio output format." + }, + "image": { + "$ref": "GoogleCloudAiplatformV1ImageResponseFormat", + "description": "Image output format." + }, + "text": { + "$ref": "GoogleCloudAiplatformV1TextResponseFormat", + "description": "Text output format." + }, + "video": { + "$ref": "GoogleCloudAiplatformV1VideoResponseFormat", + "description": "Video output format." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata": { "description": "Runtime operation information for DatasetService.RestoreDatasetVersion.", "id": "GoogleCloudAiplatformV1RestoreDatasetVersionOperationMetadata", @@ -54788,6 +59605,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentService.ResumeSandboxEnvironment.", + "id": "GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1ResumeScheduleRequest": { "description": "Request message for ScheduleService.ResumeSchedule.", "id": "GoogleCloudAiplatformV1ResumeScheduleRequest", @@ -55991,13 +60814,19 @@ "description": "Required. The category of the default container image.", "enum": [ "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", - "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" + "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE", + "DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX" ], "enumDescriptions": [ "The default value. This value is unused.", - "The default container image for Computer Use." + "The default container image for Computer Use.", + "The default container image for Shell Sandbox." ], "type": "string" + }, + "resources": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements", + "description": "Optional. Resource requests and limits for the default container." } }, "type": "object" @@ -56006,9 +60835,43 @@ "description": "Configuration for egress control of sandbox instances.", "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig", "properties": { + "customerVpcNetwork": { + "description": "Optional. The customer VPC network that sandbox egress is routed into.", + "type": "string" + }, + "dnsPeeringConfigs": { + "description": "Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.", + "items": { + "$ref": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig" + }, + "type": "array" + }, "internetAccess": { "description": "Optional. Whether to allow internet access.", "type": "boolean" + }, + "networkAttachment": { + "description": "Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig": { + "description": "Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.", + "id": "GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig", + "properties": { + "domain": { + "description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot.", + "type": "string" + }, + "targetNetwork": { + "description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", + "type": "string" + }, + "targetProject": { + "description": "Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.", + "type": "string" } }, "type": "object" @@ -60905,6 +65768,145 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SemanticGovernancePolicy": { + "description": "Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.", + "id": "GoogleCloudAiplatformV1SemanticGovernancePolicy", + "properties": { + "agent": { + "description": "Required. The name of the agent in Agent Registry that is affected by this policy.", + "type": "string" + }, + "agentIdentity": { + "description": "Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the SemanticGovernancePolicy.", + "type": "string" + }, + "displayName": { + "description": "Optional. The user-defined name of the SemanticGovernancePolicy.", + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.", + "type": "string" + }, + "mcpTools": { + "description": "Optional. The McpTools that are affected by this policy.", + "items": { + "$ref": "GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Resource name of the SemanticGovernancePolicy.", + "type": "string" + }, + "naturalLanguageConstraint": { + "description": "Required. The natural language constraint of the SemanticGovernancePolicy.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SemanticGovernancePolicyEngine": { + "description": "Define a singleton SemanticGovernancePolicyEngine resource under a project and location.", + "id": "GoogleCloudAiplatformV1SemanticGovernancePolicyEngine", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gatewayConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1GatewayConfig" + }, + "description": "Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.", + "type": "object" + }, + "ipAddress": { + "description": "Output only. The private IPv4 address of the PSC endpoint.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "type": "string" + }, + "pscForwardingRule": { + "description": "Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}", + "readOnly": true, + "type": "string" + }, + "pscServiceAttachment": { + "description": "Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the SemanticGovernancePolicyEngine.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "ACTIVE", + "DEPROVISIONING", + "INACTIVE", + "FAILED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "A provisioning operation is in progress. The engine will transition to ACTIVE on success or FAILED on failure.", + "The engine and all of its gateway configurations are provisioned and ready to serve traffic.", + "A deprovisioning operation is in progress. The engine will transition to INACTIVE on success or FAILED on failure.", + "The engine has no provisioned infrastructure: either never provisioned, or successfully deprovisioned.", + "The most recent provisioning or deprovisioning operation failed. The engine may have partial infrastructure that needs explicit deprovision; the engine may be either re-provisioned or deprovisioned to recover." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool": { + "description": "Represents a governance policy applied to MCP tools used by an Agent.", + "id": "GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool", + "properties": { + "mcpServer": { + "description": "Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`", + "type": "string" + }, + "tools": { + "description": "Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1ServiceAccountSpec", @@ -62535,6 +67537,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata": { + "description": "Metadata for the SuspendOnlineEvaluator operation.", + "id": "GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Common part of operation metadata." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest": { + "description": "Request message for SuspendOnlineEvaluator.", + "id": "GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1SyncFeatureViewRequest": { "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1SyncFeatureViewRequest", @@ -63042,6 +68061,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1TextResponseFormat": { + "description": "Configuration for text-specific output formatting.", + "id": "GoogleCloudAiplatformV1TextResponseFormat", + "properties": { + "mimeType": { + "description": "Optional. The IANA standard MIME type of the response.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "APPLICATION_JSON", + "TEXT_PLAIN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JSON output format.", + "Plain text output format." + ], + "type": "string" + }, + "schema": { + "description": "Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.", + "type": "any" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ThresholdConfig": { "description": "The config for feature monitoring threshold.", "id": "GoogleCloudAiplatformV1ThresholdConfig", @@ -63186,6 +68230,10 @@ "$ref": "GoogleCloudAiplatformV1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, + "exaAiSearch": { + "$ref": "GoogleCloudAiplatformV1ToolExaAiSearch", + "description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" + }, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { @@ -63313,15 +68361,23 @@ "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1ToolComputerUse", "properties": { + "enablePromptInjectionDetection": { + "description": "Optional. Enables the prompt injection detection check on computer-use request.", + "type": "boolean" + }, "environment": { "description": "Required. The environment being operated.", "enum": [ "ENVIRONMENT_UNSPECIFIED", - "ENVIRONMENT_BROWSER" + "ENVIRONMENT_BROWSER", + "ENVIRONMENT_MOBILE", + "ENVIRONMENT_DESKTOP" ], "enumDescriptions": [ "Defaults to browser.", - "Operates in a web browser." + "Operates in a web browser.", + "Operates in a mobile environment.", + "Operates in a desktop environment." ], "type": "string" }, @@ -63350,6 +68406,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ToolExaAiSearch": { + "description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.", + "id": "GoogleCloudAiplatformV1ToolExaAiSearch", + "properties": { + "apiKey": { + "description": "Required. The API key for ExaAiSearch.", + "type": "string" + }, + "customConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ToolGoogleSearch": { "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1ToolGoogleSearch", @@ -63499,6 +68574,15 @@ }, "description": "Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { \"source_policy\": { \"include_domains\": [\"google.com\", \"wikipedia.org\"], \"exclude_domains\": [\"example.com\"] }, \"fetch_policy\": { \"max_age_seconds\": 3600 } }", "type": "object" + }, + "enableDataRetention": { + "deprecated": true, + "description": "Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", + "type": "boolean" + }, + "enableZeroDataRetention": { + "description": "Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", + "type": "boolean" } }, "type": "object" @@ -64761,6 +69845,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata": { + "description": "Metadata for the UpdateOnlineEvaluator operation.", + "id": "GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "Generic operation metadata." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata": { "description": "Details of operations that perform update PersistentResource.", "id": "GoogleCloudAiplatformV1UpdatePersistentResourceOperationMetadata", @@ -65096,6 +70191,49 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1UserScenario": { + "description": "Output of user scenario generation.", + "id": "GoogleCloudAiplatformV1UserScenario", + "properties": { + "conversationPlan": { + "description": "Conversation plan to drive multi-turn agent run and get simulated agent eval dataset.", + "type": "string" + }, + "startingPrompt": { + "description": "Starting prompt for the conversation between simulated user and agent under the test.", + "type": "string" + }, + "testCaseTitle": { + "description": "Represents a short 3-5 word title for eval test case.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1UserScenarioGenerationConfig": { + "description": "User scenario generation configuration.", + "id": "GoogleCloudAiplatformV1UserScenarioGenerationConfig", + "properties": { + "environmentData": { + "description": "Optional. Environment data in string type.", + "type": "string" + }, + "modelName": { + "description": "Optional. The model name to use for generation. It can be model name, e.g. \"gemini-3-pro-preview\". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "type": "string" + }, + "simulationInstruction": { + "description": "Optional. Simulation instruction to guide the user scenario generation.", + "type": "string" + }, + "userScenarioCount": { + "description": "Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Value": { "description": "Value is the value of the field.", "id": "GoogleCloudAiplatformV1Value", @@ -65270,6 +70408,50 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1VideoResponseFormat": { + "description": "Configuration for video-specific output formatting.", + "id": "GoogleCloudAiplatformV1VideoResponseFormat", + "properties": { + "aspectRatio": { + "description": "The aspect ratio for the video output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_NINE_BY_SIXTEEN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "16:9 aspect ratio.", + "9:16 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "duration": { + "description": "Optional. The duration for the video output.", + "format": "google-duration", + "type": "string" + }, + "gcsUri": { + "description": "Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1VoiceConfig": { "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1VoiceConfig", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index 5ab500959af..6f9c8c85db4 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -5747,31 +5747,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes an interaction.", - "flatPath": "v1beta1/interactions/{interactionsId}", - "httpMethod": "DELETE", - "id": "aiplatform.interactions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", - "location": "path", - "pattern": "^interactions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleApiHttpBody" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getPoll": { "description": "Fully typed proto, unary version of GetInteraction that returns Interaction proto.", "flatPath": "v1beta1/interactions/{interactionsId}:poll", @@ -5781,13 +5756,13 @@ "name" ], "parameters": { - "include_input": { + "includeInput": { "deprecated": true, "description": "Optional. If true, includes the input in the response.", "location": "query", "type": "boolean" }, - "last_event_id": { + "lastEventId": { "description": "Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", "location": "query", "type": "string" @@ -5822,13 +5797,13 @@ "name" ], "parameters": { - "include_input": { + "includeInput": { "deprecated": true, "description": "Optional. If true, includes the input in the response.", "location": "query", "type": "boolean" }, - "last_event_id": { + "lastEventId": { "description": "Optional. If set, resumes the interaction stream from the chunk after the event marked by the event id. Can only be used if `stream` is true.", "location": "query", "type": "string" @@ -5900,17 +5875,352 @@ } } }, - "metadataStores": { + "memoryBanks": { + "methods": { + "ingestEvents": { + "description": "Ingests events for a Memory Bank.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}:ingestEvents", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.ingestEvents", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:ingestEvents", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { - "artifacts": { + "memories": { + "methods": { + "create": { + "description": "Create a Memory.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "memoryId": { + "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a Memory.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.memoryBanks.memories.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a Memory.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.memories.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memories.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories", + "httpMethod": "GET", + "id": "aiplatform.memoryBanks.memories.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a Memory.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.memoryBanks.memories.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Purge memories.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:purge", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieve", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.retrieve", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:retrieve", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveProfiles": { + "description": "Retrieves profiles.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.retrieveProfiles", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:retrieveProfiles", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", + "httpMethod": "POST", + "id": "aiplatform.memoryBanks.memories.rollback", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:rollback", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.metadataStores.artifacts.operations.cancel", + "id": "aiplatform.memoryBanks.memories.operations.cancel", "parameterOrder": [ "name" ], @@ -5918,7 +6228,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5933,9 +6243,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.metadataStores.artifacts.operations.delete", + "id": "aiplatform.memoryBanks.memories.operations.delete", "parameterOrder": [ "name" ], @@ -5943,7 +6253,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5958,9 +6268,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.metadataStores.artifacts.operations.get", + "id": "aiplatform.memoryBanks.memories.operations.get", "parameterOrder": [ "name" ], @@ -5968,7 +6278,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5983,9 +6293,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", "httpMethod": "GET", - "id": "aiplatform.metadataStores.artifacts.operations.list", + "id": "aiplatform.memoryBanks.memories.operations.list", "parameterOrder": [ "name" ], @@ -5998,7 +6308,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" }, @@ -6029,9 +6339,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.metadataStores.artifacts.operations.wait", + "id": "aiplatform.memoryBanks.memories.operations.wait", "parameterOrder": [ "name" ], @@ -6039,7 +6349,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6059,320 +6369,70 @@ ] } } - } - } - }, - "contexts": { - "resources": { - "operations": { + }, + "revisions": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.metadataStores.contexts.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.metadataStores.contexts.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "description": "Get a Memory Revision.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", "httpMethod": "GET", - "id": "aiplatform.metadataStores.contexts.operations.get", + "id": "aiplatform.memoryBanks.memories.revisions.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", "location": "path", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", "httpMethod": "GET", - "id": "aiplatform.metadataStores.contexts.operations.list", + "id": "aiplatform.memoryBanks.memories.revisions.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", - "required": true, - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. 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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.metadataStores.contexts.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "parent": { + "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+parent}/revisions", "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "executions": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.metadataStores.executions.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.metadataStores.executions.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.metadataStores.executions.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.metadataStores.executions.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^metadataStores/[^/]+/executions/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.metadataStores.executions.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -6386,9 +6446,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.metadataStores.operations.cancel", + "id": "aiplatform.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -6396,7 +6456,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6411,9 +6471,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.metadataStores.operations.delete", + "id": "aiplatform.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -6421,7 +6481,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6436,9 +6496,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.metadataStores.operations.get", + "id": "aiplatform.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -6446,7 +6506,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6461,9 +6521,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", - "id": "aiplatform.metadataStores.operations.list", + "id": "aiplatform.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -6476,7 +6536,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^metadataStores/[^/]+$", + "pattern": "^memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -6507,9 +6567,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.metadataStores.operations.wait", + "id": "aiplatform.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -6517,7 +6577,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^metadataStores/[^/]+/operations/[^/]+$", + "pattern": "^memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -6540,497 +6600,337 @@ } } }, - "migratableResources": { + "metadataStores": { "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.migratableResources.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.migratableResources.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.migratableResources.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.migratableResources.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^migratableResources/[^/]+$", - "required": true, - "type": "string" + "artifacts": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.artifacts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.artifacts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.migratableResources.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^migratableResources/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.artifacts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/artifacts/{artifactsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.artifacts.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/artifacts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } - } - } - }, - "modelDeploymentMonitoringJobs": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "modelMonitors": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.modelMonitors.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.modelMonitors.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.modelMonitors.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.modelMonitors.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^modelMonitors/[^/]+$", - "required": true, - "type": "string" + }, + "contexts": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.metadataStores.contexts.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.modelMonitors.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.metadataStores.contexts.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/contexts/{contextsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.metadataStores.contexts.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^metadataStores/[^/]+/contexts/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } - } - } - }, - "models": { - "resources": { - "evaluations": { + }, + "executions": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.models.evaluations.operations.cancel", + "id": "aiplatform.metadataStores.executions.operations.cancel", "parameterOrder": [ "name" ], @@ -7038,7 +6938,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7053,9 +6953,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.models.evaluations.operations.delete", + "id": "aiplatform.metadataStores.executions.operations.delete", "parameterOrder": [ "name" ], @@ -7063,7 +6963,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7078,9 +6978,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.models.evaluations.operations.get", + "id": "aiplatform.metadataStores.executions.operations.get", "parameterOrder": [ "name" ], @@ -7088,7 +6988,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7103,9 +7003,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations", "httpMethod": "GET", - "id": "aiplatform.models.evaluations.operations.list", + "id": "aiplatform.metadataStores.executions.operations.list", "parameterOrder": [ "name" ], @@ -7118,7 +7018,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^models/[^/]+/evaluations/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+$", "required": true, "type": "string" }, @@ -7149,9 +7049,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/executions/{executionsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.models.evaluations.operations.wait", + "id": "aiplatform.metadataStores.executions.operations.wait", "parameterOrder": [ "name" ], @@ -7159,7 +7059,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/executions/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7186,9 +7086,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.models.operations.cancel", + "id": "aiplatform.metadataStores.operations.cancel", "parameterOrder": [ "name" ], @@ -7196,7 +7096,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^models/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7211,9 +7111,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.models.operations.delete", + "id": "aiplatform.metadataStores.operations.delete", "parameterOrder": [ "name" ], @@ -7221,7 +7121,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^models/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7236,9 +7136,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.models.operations.get", + "id": "aiplatform.metadataStores.operations.get", "parameterOrder": [ "name" ], @@ -7246,7 +7146,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^models/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7261,9 +7161,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/models/{modelsId}/operations", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations", "httpMethod": "GET", - "id": "aiplatform.models.operations.list", + "id": "aiplatform.metadataStores.operations.list", "parameterOrder": [ "name" ], @@ -7276,7 +7176,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^models/[^/]+$", + "pattern": "^metadataStores/[^/]+$", "required": true, "type": "string" }, @@ -7307,9 +7207,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/metadataStores/{metadataStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.models.operations.wait", + "id": "aiplatform.metadataStores.operations.wait", "parameterOrder": [ "name" ], @@ -7317,7 +7217,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^models/[^/]+/operations/[^/]+$", + "pattern": "^metadataStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7340,15 +7240,15 @@ } } }, - "notebookExecutionJobs": { + "migratableResources": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.notebookExecutionJobs.operations.cancel", + "id": "aiplatform.migratableResources.operations.cancel", "parameterOrder": [ "name" ], @@ -7356,7 +7256,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7371,9 +7271,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.notebookExecutionJobs.operations.delete", + "id": "aiplatform.migratableResources.operations.delete", "parameterOrder": [ "name" ], @@ -7381,7 +7281,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7396,9 +7296,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.notebookExecutionJobs.operations.get", + "id": "aiplatform.migratableResources.operations.get", "parameterOrder": [ "name" ], @@ -7406,7 +7306,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7421,9 +7321,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations", "httpMethod": "GET", - "id": "aiplatform.notebookExecutionJobs.operations.list", + "id": "aiplatform.migratableResources.operations.list", "parameterOrder": [ "name" ], @@ -7436,7 +7336,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^notebookExecutionJobs/[^/]+$", + "pattern": "^migratableResources/[^/]+$", "required": true, "type": "string" }, @@ -7467,9 +7367,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/migratableResources/{migratableResourcesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.notebookExecutionJobs.operations.wait", + "id": "aiplatform.migratableResources.operations.wait", "parameterOrder": [ "name" ], @@ -7477,7 +7377,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", + "pattern": "^migratableResources/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7500,15 +7400,15 @@ } } }, - "notebookRuntimeTemplates": { + "modelDeploymentMonitoringJobs": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -7516,7 +7416,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7531,9 +7431,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.notebookRuntimeTemplates.operations.delete", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.delete", "parameterOrder": [ "name" ], @@ -7541,7 +7441,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7556,9 +7456,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.notebookRuntimeTemplates.operations.get", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.get", "parameterOrder": [ "name" ], @@ -7566,7 +7466,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7581,9 +7481,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.notebookRuntimeTemplates.operations.list", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.list", "parameterOrder": [ "name" ], @@ -7596,7 +7496,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^notebookRuntimeTemplates/[^/]+$", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+$", "required": true, "type": "string" }, @@ -7627,9 +7527,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/modelDeploymentMonitoringJobs/{modelDeploymentMonitoringJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.notebookRuntimeTemplates.operations.wait", + "id": "aiplatform.modelDeploymentMonitoringJobs.operations.wait", "parameterOrder": [ "name" ], @@ -7637,7 +7537,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", + "pattern": "^modelDeploymentMonitoringJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7660,15 +7560,15 @@ } } }, - "notebookRuntimes": { + "modelMonitors": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.notebookRuntimes.operations.cancel", + "id": "aiplatform.modelMonitors.operations.cancel", "parameterOrder": [ "name" ], @@ -7676,7 +7576,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7691,9 +7591,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.notebookRuntimes.operations.delete", + "id": "aiplatform.modelMonitors.operations.delete", "parameterOrder": [ "name" ], @@ -7701,7 +7601,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7716,9 +7616,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.notebookRuntimes.operations.get", + "id": "aiplatform.modelMonitors.operations.get", "parameterOrder": [ "name" ], @@ -7726,7 +7626,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7741,9 +7641,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations", "httpMethod": "GET", - "id": "aiplatform.notebookRuntimes.operations.list", + "id": "aiplatform.modelMonitors.operations.list", "parameterOrder": [ "name" ], @@ -7756,7 +7656,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^notebookRuntimes/[^/]+$", + "pattern": "^modelMonitors/[^/]+$", "required": true, "type": "string" }, @@ -7787,9 +7687,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/modelMonitors/{modelMonitorsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.notebookRuntimes.operations.wait", + "id": "aiplatform.modelMonitors.operations.wait", "parameterOrder": [ "name" ], @@ -7797,7 +7697,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", + "pattern": "^modelMonitors/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7820,15 +7720,175 @@ } } }, - "onlineEvaluators": { + "models": { "resources": { + "evaluations": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.models.evaluations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.models.evaluations.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/models/{modelsId}/evaluations/{evaluationsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.models.evaluations.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^models/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.onlineEvaluators.operations.cancel", + "id": "aiplatform.models.operations.cancel", "parameterOrder": [ "name" ], @@ -7836,7 +7896,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7851,9 +7911,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.onlineEvaluators.operations.delete", + "id": "aiplatform.models.operations.delete", "parameterOrder": [ "name" ], @@ -7861,7 +7921,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7876,9 +7936,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.onlineEvaluators.operations.get", + "id": "aiplatform.models.operations.get", "parameterOrder": [ "name" ], @@ -7886,7 +7946,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -7901,9 +7961,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations", + "flatPath": "v1beta1/models/{modelsId}/operations", "httpMethod": "GET", - "id": "aiplatform.onlineEvaluators.operations.list", + "id": "aiplatform.models.operations.list", "parameterOrder": [ "name" ], @@ -7916,7 +7976,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^onlineEvaluators/[^/]+$", + "pattern": "^models/[^/]+$", "required": true, "type": "string" }, @@ -7947,9 +8007,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/models/{modelsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.onlineEvaluators.operations.wait", + "id": "aiplatform.models.operations.wait", "parameterOrder": [ "name" ], @@ -7957,7 +8017,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", + "pattern": "^models/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -7980,167 +8040,15 @@ } } }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/operations", - "httpMethod": "GET", - "id": "aiplatform.operations.list", - "parameterOrder": [], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "persistentResources": { + "notebookExecutionJobs": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.persistentResources.operations.cancel", + "id": "aiplatform.notebookExecutionJobs.operations.cancel", "parameterOrder": [ "name" ], @@ -8148,7 +8056,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8163,9 +8071,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.persistentResources.operations.delete", + "id": "aiplatform.notebookExecutionJobs.operations.delete", "parameterOrder": [ "name" ], @@ -8173,7 +8081,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8188,9 +8096,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.persistentResources.operations.get", + "id": "aiplatform.notebookExecutionJobs.operations.get", "parameterOrder": [ "name" ], @@ -8198,7 +8106,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8213,9 +8121,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations", "httpMethod": "GET", - "id": "aiplatform.persistentResources.operations.list", + "id": "aiplatform.notebookExecutionJobs.operations.list", "parameterOrder": [ "name" ], @@ -8228,7 +8136,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^persistentResources/[^/]+$", + "pattern": "^notebookExecutionJobs/[^/]+$", "required": true, "type": "string" }, @@ -8259,9 +8167,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/notebookExecutionJobs/{notebookExecutionJobsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.persistentResources.operations.wait", + "id": "aiplatform.notebookExecutionJobs.operations.wait", "parameterOrder": [ "name" ], @@ -8269,7 +8177,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "pattern": "^notebookExecutionJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -8292,15 +8200,15 @@ } } }, - "pipelineJobs": { + "notebookRuntimeTemplates": { "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.pipelineJobs.operations.cancel", + "id": "aiplatform.notebookRuntimeTemplates.operations.cancel", "parameterOrder": [ "name" ], @@ -8308,7 +8216,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8323,9 +8231,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.pipelineJobs.operations.delete", + "id": "aiplatform.notebookRuntimeTemplates.operations.delete", "parameterOrder": [ "name" ], @@ -8333,7 +8241,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8348,9 +8256,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.pipelineJobs.operations.get", + "id": "aiplatform.notebookRuntimeTemplates.operations.get", "parameterOrder": [ "name" ], @@ -8358,7 +8266,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -8373,9 +8281,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations", "httpMethod": "GET", - "id": "aiplatform.pipelineJobs.operations.list", + "id": "aiplatform.notebookRuntimeTemplates.operations.list", "parameterOrder": [ "name" ], @@ -8388,7 +8296,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^pipelineJobs/[^/]+$", + "pattern": "^notebookRuntimeTemplates/[^/]+$", "required": true, "type": "string" }, @@ -8419,9 +8327,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/notebookRuntimeTemplates/{notebookRuntimeTemplatesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.pipelineJobs.operations.wait", + "id": "aiplatform.notebookRuntimeTemplates.operations.wait", "parameterOrder": [ "name" ], @@ -8429,7 +8337,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "pattern": "^notebookRuntimeTemplates/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -8452,251 +8360,78 @@ } } }, - "projects": { - "methods": { - "fetchPublisherModelConfig": { - "description": "Fetches the configs of publisher models.", - "flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.fetchPublisherModelConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:fetchPublisherModelConfig", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getCacheConfig": { - "description": "Gets a GenAI cache config.", - "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", - "httpMethod": "GET", - "id": "aiplatform.projects.getCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setPublisherModelConfig": { - "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", - "flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig", - "httpMethod": "POST", - "id": "aiplatform.projects.setPublisherModelConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:setPublisherModelConfig", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "updateCacheConfig": { - "description": "Updates a cache config.", - "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.updateCacheConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", - "location": "path", - "pattern": "^projects/[^/]+/cacheConfig$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, + "notebookRuntimes": { "resources": { - "locations": { + "operations": { "methods": { - "askContexts": { - "description": "Agentic Retrieval Ask API for RAG.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:askContexts", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.askContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:askContexts", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AskContextsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1AskContextsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "asyncRetrieveContexts": { - "description": "Asynchronous API to retrieves relevant contexts for a query.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.asyncRetrieveContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}:asyncRetrieveContexts", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "augmentPrompt": { - "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.augmentPrompt", + "id": "aiplatform.notebookRuntimes.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}:augmentPrompt", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "corroborateContent": { - "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.corroborateContent", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.notebookRuntimes.operations.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}:corroborateContent", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deploy": { - "description": "Deploys a model to a new endpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deploy", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.get", "parameterOrder": [ - "destination" + "name" ], "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+destination}:deploy", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -8704,1022 +8439,2169 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "deployPublisherModel": { - "deprecated": true, - "description": "Deploys publisher models.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.deployPublisherModel", + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.notebookRuntimes.operations.list", "parameterOrder": [ - "destination" + "name" ], "parameters": { - "destination": { - "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "filter": { + "description": "The standard list filter.", + "location": "query", "type": "string" - } - }, - "path": "v1beta1/{+destination}:deployPublisherModel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "evaluateDataset": { - "description": "Evaluates a dataset based on a set of given metrics.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateDataset", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + }, + "name": { + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^notebookRuntimes/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+location}:evaluateDataset", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "evaluateInstances": { - "description": "Evaluates instances based on a given metric.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.evaluateInstances", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+location}:evaluateInstances", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" - }, + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateInstanceRubrics": { - "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/notebookRuntimes/{notebookRuntimesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateInstanceRubrics", + "id": "aiplatform.notebookRuntimes.operations.wait", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^notebookRuntimes/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+location}:generateInstanceRubrics", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generateLossClusters": { - "description": "Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateLossClusters", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateLossClusters", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+location}:generateLossClusters", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "generateSyntheticData": { - "description": "Generates synthetic (artificial) data based on a description", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateSyntheticData", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+location}:generateSyntheticData", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "generateUserScenarios": { - "description": "Generates user scenarios for agent evaluation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios", + } + } + } + } + }, + "onlineEvaluators": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.generateUserScenarios", + "id": "aiplatform.onlineEvaluators.operations.cancel", "parameterOrder": [ - "location" + "name" ], "parameters": { - "location": { - "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+location}:generateUserScenarios", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets information about a location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.get", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.onlineEvaluators.operations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Resource name for the location.", + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudLocationLocation" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getRagEngineConfig": { - "description": "Gets a RagEngineConfig.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.getRagEngineConfig", + "id": "aiplatform.onlineEvaluators.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", - "flatPath": "v1beta1/projects/{projectsId}/locations", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.list", + "id": "aiplatform.onlineEvaluators.operations.list", "parameterOrder": [ "name" ], "parameters": { - "extraLocationTypes": { - "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", - "location": "query", - "repeated": true, - "type": "string" - }, "filter": { - "description": "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).", + "description": "The standard list filter.", "location": "query", "type": "string" }, "name": { - "description": "The resource that owns the locations collection, if applicable.", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+$", + "pattern": "^onlineEvaluators/[^/]+$", "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of results to return. If not set, the service selects a default.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "path": "v1beta1/{+name}/locations", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudLocationListLocationsResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "recommendSpec": { - "description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/onlineEvaluators/{onlineEvaluatorsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.recommendSpec", + "id": "aiplatform.onlineEvaluators.operations.wait", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "name": { + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^onlineEvaluators/[^/]+/operations/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+parent}:recommendSpec", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "retrieveContexts": { - "description": "Retrieves relevant contexts for a query.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.retrieveContexts", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", "type": "string" } }, - "path": "v1beta1/{+parent}:retrieveContexts", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "updateRagEngineConfig": { - "description": "Updates a RagEngineConfig.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.updateRagEngineConfig", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", - "required": true, - "type": "string" - } - }, + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/operations", + "httpMethod": "GET", + "id": "aiplatform.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "persistentResources": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.persistentResources.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "agents": { - "methods": { - "create": { - "description": "Creates a new Agent in a given location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.agents.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/agents", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Agent" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.persistentResources.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "delete": { - "description": "Deletes the specific Agent.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.agents.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^persistentResources/[^/]+$", + "required": true, + "type": "string" }, - "get": { - "description": "Gets details of the specific Agent.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.agents.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "list": { - "description": "Lists Agents in a given location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.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: * `create_time` * `update_time` Example: `create_time desc`.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of agents to return. The service may return fewer than this value. If unspecified, at most 100 agents will be returned.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list AgentService.ListAgents call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/agents", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListAgentsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "patch": { - "description": "Updates the specific Agent.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.agents.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Agent" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Agent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.agents.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.agents.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.agents.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.agents.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.agents.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/persistentResources/{persistentResourcesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.persistentResources.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^persistentResources/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "pipelineJobs": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "apps": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.apps.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.apps.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.apps.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.apps.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.apps.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.pipelineJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" } - } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "batchPredictionJobs": { - "methods": { - "cancel": { - "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.pipelineJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "create": { - "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.batchPredictionJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/batchPredictionJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+$", + "required": true, + "type": "string" }, - "delete": { - "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.batchPredictionJobs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "get": { - "description": "Gets a BatchPredictionJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" }, - "list": { - "description": "Lists BatchPredictionJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.batchPredictionJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/batchPredictionJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } - } - }, - "cachedContents": { - "methods": { - "create": { - "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/pipelineJobs/{pipelineJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.pipelineJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^pipelineJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "projects": { + "methods": { + "fetchPublisherModelConfig": { + "description": "Fetches the configs of publisher models.", + "flatPath": "v1beta1/projects/{projectsId}:fetchPublisherModelConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.fetchPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:fetchPublisherModelConfig", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getCacheConfig": { + "description": "Gets a GenAI cache config.", + "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.getCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setPublisherModelConfig": { + "description": "Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.", + "flatPath": "v1beta1/projects/{projectsId}:setPublisherModelConfig", + "httpMethod": "POST", + "id": "aiplatform.projects.setPublisherModelConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the publisher model, in the format of `projects/{project}/locations/{location}/publishers/{publisher}/models/{model}`.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:setPublisherModelConfig", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SetPublisherModelConfigRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateCacheConfig": { + "description": "Updates a cache config.", + "flatPath": "v1beta1/projects/{projectsId}/cacheConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.updateCacheConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", + "location": "path", + "pattern": "^projects/[^/]+/cacheConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CacheConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "locations": { + "methods": { + "askContexts": { + "description": "Agentic Retrieval Ask API for RAG.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:askContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.askContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:askContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AskContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AskContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "asyncRetrieveContexts": { + "description": "Asynchronous API to retrieves relevant contexts for a query.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:asyncRetrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.asyncRetrieveContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:asyncRetrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AsyncRetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "augmentPrompt": { + "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.augmentPrompt", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:augmentPrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "corroborateContent": { + "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.corroborateContent", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:corroborateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deploy": { + "description": "Deploys a model to a new endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deploy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deploy", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+destination}:deploy", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployPublisherModel": { + "deprecated": true, + "description": "Deploys publisher models.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:deployPublisherModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.deployPublisherModel", + "parameterOrder": [ + "destination" + ], + "parameters": { + "destination": { + "description": "Required. The resource name of the Location to deploy the model in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+destination}:deployPublisherModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployPublisherModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateDataset": { + "description": "Evaluates a dataset based on a set of given metrics.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateDataset", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateDataset", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:evaluateDataset", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateDatasetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "evaluateInstances": { + "description": "Evaluates instances based on a given metric.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluateInstances", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to evaluate the instances. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:evaluateInstances", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluateInstancesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateInstanceRubrics": { + "description": "Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateInstanceRubrics", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateInstanceRubrics", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to generate rubrics from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateInstanceRubrics", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateInstanceRubricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateLossClusters": { + "description": "Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateLossClusters", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateLossClusters", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateLossClusters", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateLossClustersRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateSyntheticData": { + "description": "Generates synthetic (artificial) data based on a description", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateSyntheticData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateSyntheticData", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project}/locations/{location}`. For example, `projects/my-project/locations/us-central1`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateSyntheticData", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateSyntheticDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateUserScenarios": { + "description": "Generates user scenarios for agent evaluation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:generateUserScenarios", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.generateUserScenarios", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to run the job. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+location}:generateUserScenarios", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateUserScenariosResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets information about a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudLocationLocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getRagEngineConfig": { + "description": "Gets a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the RagEngineConfig resource. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getSemanticGovernancePolicyEngine": { + "description": "Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.getSemanticGovernancePolicyEngine", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", + "flatPath": "v1beta1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "extraLocationTypes": { + "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", + "location": "query", + "repeated": true, + "type": "string" + }, + "filter": { + "description": "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).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}/locations", + "response": { + "$ref": "GoogleCloudLocationListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "recommendSpec": { + "description": "Gets a Model's spec recommendations. This API is called by UI, SDK, and internal.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:recommendSpec", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.recommendSpec", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to recommend specs. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:recommendSpec", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RecommendSpecResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveContexts": { + "description": "Retrieves relevant contexts for a query.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:retrieveContexts", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.retrieveContexts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:retrieveContexts", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateRagEngineConfig": { + "description": "Updates a RagEngineConfig.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragEngineConfig", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateRagEngineConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The name of the RagEngineConfig. Format: `projects/{project}/locations/{location}/ragEngineConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragEngineConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RagEngineConfig" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateSemanticGovernancePolicyEngine": { + "description": "Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.updateSemanticGovernancePolicyEngine", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "agentAnomalyDetectionScopes": { + "methods": { + "create": { + "description": "Creates a new AgentAnomalyDetectionScope.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "agentAnomalyDetectionScopeId": { + "description": "Required. The ID to use for the AgentAnomalyDetectionScope, which will become the final component of the AgentAnomalyDetectionScope's resource name. This value should be 1-63 characters, and valid characters are /[a-z]([a-z0-9-]{0,61}[a-z0-9])?/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the AgentAnomalyDetectionScope in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agentAnomalyDetectionScopes", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a specific AgentAnomalyDetectionScope.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AgentAnomalyDetectionScope resource to be deleted. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific AgentAnomalyDetectionScope.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes/{agentAnomalyDetectionScopesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AgentAnomalyDetectionScope resource. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentAnomalyDetectionScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AgentAnomalyDetectionScopes in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentAnomalyDetectionScopes", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agentAnomalyDetectionScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 AgentAnomalyDetectionScopes will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the AgentAnomalyDetectionScopes from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agentAnomalyDetectionScopes", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "agents": { + "methods": { + "create": { + "description": "Creates an agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the agent in. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agents", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agents.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent to delete. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves an agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the agent to retrieve. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists agents in a location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to list agents from. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agents", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an agent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.agents.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update. If not present, all fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Agent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.agents.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.agents.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.agents.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "apps": { + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.apps.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.apps.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.apps.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.apps.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.apps.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "batchPredictionJobs": { + "methods": { + "cancel": { + "description": "Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelBatchPredictionJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.batchPredictionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/batchPredictionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BatchPredictionJob. Can only be called on jobs that already finished.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.batchPredictionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a BatchPredictionJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs/{batchPredictionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the BatchPredictionJob resource. Format: `projects/{project}/locations/{location}/batchPredictionJobs/{batch_prediction_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batchPredictionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1BatchPredictionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BatchPredictionJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/batchPredictionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.batchPredictionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/batchPredictionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListBatchPredictionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "cachedContents": { + "methods": { + "create": { + "description": "Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cachedContents", "httpMethod": "POST", "id": "aiplatform.projects.locations.cachedContents.create", @@ -14799,6 +15681,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "import": { + "description": "Imports an Evaluation Set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.evaluationSets.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Parent resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/evaluationSets:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Evaluation Sets.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/evaluationSets", @@ -15883,61 +16793,450 @@ ], "parameters": { "filter": { - "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", + "description": "Optional. The standard list filter. Supported fields: * `display_name` * `create_time` * `update_time` More detail in [AIP-160](https://google.aip.dev/160).", + "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/extensions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates an Extension.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.extensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the Extension.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Extension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "query": { + "description": "Queries an extension with a default controller.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.query", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:query", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.extensions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.extensions.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.extensions.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "featureGroups": { + "methods": { + "create": { + "description": "Creates a new FeatureGroup in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureGroupId": { + "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureGroups", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureGroup resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", "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: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard list page size.", + "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard list page token.", + "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the Extensions from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/extensions", + "path": "v1beta1/{+parent}/featureGroups", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" + "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates an Extension.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}", + "description": "Updates the parameters of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.extensions.patch", + "id": "aiplatform.projects.locations.featureGroups.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The resource name of the Extension.", + "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `runtime_config` * `tool_use_examples` * `manifest.description`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -15945,38 +17244,69 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Extension" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "query": { - "description": "Queries an extension with a default controller.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}:query", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.query", + "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", "parameterOrder": [ - "name" + "resource" ], "parameters": { - "name": { - "description": "Required. Name (identifier) of the extension; Format: `projects/{project}/locations/{location}/extensions/{extension}`", + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:query", + "path": "v1beta1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionRequest" + "$ref": "GoogleIamV1SetIamPolicyRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1QueryExtensionResponse" + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, + "type": "string" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -15984,38 +17314,780 @@ } }, "resources": { - "operations": { + "featureMonitors": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:cancel", + "create": { + "description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureMonitorId": { + "description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitors", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitor resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "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: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitors", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureMonitor.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureMonitorJobs": { + "methods": { + "create": { + "description": "Creates a new feature monitor job.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureMonitorJobId": { + "description": "Optional. Output only. System-generated ID for feature monitor job.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitorJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a feature monitor job.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List feature monitor jobs.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.", + "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: * `create_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureMonitorJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Feature in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.operations.cancel", + "id": "aiplatform.projects.locations.featureGroups.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be cancelled.", + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "featureStatsAndAnomalySpec.latestStatsCount": { + "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "featureStatsAndAnomalySpec.statsTimeRange.endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "featureStatsAndAnomalySpec.statsTimeRange.startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.extensions.operations.delete", + "id": "aiplatform.projects.locations.featureGroups.operations.delete", "parameterOrder": [ "name" ], @@ -16023,7 +18095,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16038,9 +18110,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.operations.get", + "id": "aiplatform.projects.locations.featureGroups.operations.get", "parameterOrder": [ "name" ], @@ -16048,7 +18120,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -16063,9 +18135,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.extensions.operations.list", + "id": "aiplatform.projects.locations.featureGroups.operations.list", "parameterOrder": [ "name" ], @@ -16078,7 +18150,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", "required": true, "type": "string" }, @@ -16109,9 +18181,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/extensions/{extensionsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.extensions.operations.wait", + "id": "aiplatform.projects.locations.featureGroups.operations.wait", "parameterOrder": [ "name" ], @@ -16119,7 +18191,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/extensions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -16142,33 +18214,33 @@ } } }, - "featureGroups": { + "featureOnlineStores": { "methods": { "create": { - "description": "Creates a new FeatureGroup in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "description": "Creates a new FeatureOnlineStore in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.create", + "id": "aiplatform.projects.locations.featureOnlineStores.create", "parameterOrder": [ "parent" ], "parameters": { - "featureGroupId": { - "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "featureOnlineStoreId": { + "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureGroups", + "path": "v1beta1/{+parent}/featureOnlineStores", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16178,23 +18250,23 @@ ] }, "delete": { - "description": "Deletes a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.delete", + "id": "aiplatform.projects.locations.featureOnlineStores.delete", "parameterOrder": [ "name" ], "parameters": { "force": { - "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", + "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } @@ -16208,25 +18280,25 @@ ] }, "get": { - "description": "Gets details of a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "description": "Gets details of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.get", + "id": "aiplatform.projects.locations.featureOnlineStores.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureGroup resource.", + "description": "Required. The name of the FeatureOnlineStore resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -16234,9 +18306,9 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:getIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.getIamPolicy", + "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", "parameterOrder": [ "resource" ], @@ -16250,7 +18322,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } @@ -16264,16 +18336,16 @@ ] }, "list": { - "description": "Lists FeatureGroups in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "description": "Lists FeatureOnlineStores in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.list", + "id": "aiplatform.projects.locations.featureOnlineStores.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", "location": "query", "type": "string" }, @@ -16283,50 +18355,50 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token.", + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureGroups", + "path": "v1beta1/{+parent}/featureOnlineStores", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "description": "Updates the parameters of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.patch", + "id": "aiplatform.projects.locations.featureOnlineStores.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -16334,7 +18406,7 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16345,9 +18417,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:setIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.setIamPolicy", + "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", "parameterOrder": [ "resource" ], @@ -16355,7 +18427,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } @@ -16373,9 +18445,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}:testIamPermissions", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.testIamPermissions", + "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", "parameterOrder": [ "resource" ], @@ -16389,7 +18461,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } @@ -16404,155 +18476,275 @@ } }, "resources": { - "featureMonitors": { + "featureViews": { "methods": { "create": { - "description": "Creates a new FeatureMonitor in a given project, location and FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "description": "Creates a new FeatureView in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureViewId": { + "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "runSyncImmediately": { + "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+parent}/featureViews", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "directWrite": { + "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.create", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", "parameterOrder": [ - "parent" + "featureView" ], "parameters": { - "featureMonitorId": { - "description": "Required. The ID to use for this FeatureMonitor, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the FeatureGroup.", - "location": "query", + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, "type": "string" - }, - "parent": { - "description": "Required. The resource name of FeatureGroup to create FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featuregroup}`", + } + }, + "path": "v1beta1/{+featureView}:directWrite", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchFeatureValues": { + "description": "Fetch feature values under a FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureMonitors", + "path": "v1beta1/{+featureView}:fetchFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.delete", + "generateFetchAccessToken": { + "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", "parameterOrder": [ - "name" + "featureView" ], "parameters": { - "name": { - "description": "Required. The name of the FeatureMonitor to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", + "featureView": { + "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+featureView}:generateFetchAccessToken", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "description": "Gets details of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.get", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureMonitor resource.", + "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists FeatureGroups in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors", + "description": "Lists FeatureViews in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.list", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. Lists the FeatureMonitors that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureMonitors created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", "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: * `create_time` * `update_time`", + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitors will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitors call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitors must match the call that provided the page token.", + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the FeatureGroup to list FeatureMonitors. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureMonitors", + "path": "v1beta1/{+parent}/featureViews", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single FeatureMonitor.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}", + "description": "Updates the parameters of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.patch", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureMonitor. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}`", + "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the FeatureMonitor resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `schedule_config` * `feature_selection_config`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -16560,7 +18752,7 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitor" + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -16568,469 +18760,145 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "featureMonitorJobs": { - "methods": { - "create": { - "description": "Creates a new feature monitor job.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureMonitorJobId": { - "description": "Optional. Output only. System-generated ID for feature monitor job.", - "format": "int64", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of FeatureMonitor to create FeatureMonitorJob. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitorJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Get a feature monitor job.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs/{featureMonitorJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureMonitorJob resource. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/featureMonitorJobs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureMonitorJob" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "List feature monitor jobs.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/featureMonitorJobs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.featureMonitorJobs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. Lists the FeatureMonitorJobs that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be Examples: * `create_time > \"2020-01-01\"` FeatureMonitorJobs created after 2020-01-01.", - "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: * `create_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of FeatureMonitorJobs to return. The service may return fewer than this value. If unspecified, at most 100 FeatureMonitorJobs will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous FeatureRegistryService.ListFeatureMonitorJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureMonitorJobs must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureMonitor to list FeatureMonitorJobs. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureMonitorJobs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureMonitorJobsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } }, - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/featureMonitors/{featureMonitorsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.featureMonitors.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/featureMonitors/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "features": { - "methods": { - "batchCreate": { - "description": "Creates a batch of Features in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features:batchCreate", + "searchNearestEntities": { + "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.batchCreate", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", "parameterOrder": [ - "parent" + "featureView" ], "parameters": { - "parent": { - "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/features:batchCreate", + "path": "v1beta1/{+featureView}:searchNearestEntities", "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a new Feature in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.create", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", "parameterOrder": [ - "parent" + "resource" ], "parameters": { - "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/features", + "path": "v1beta1/{+resource}:setIamPolicy", "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } + "$ref": "GoogleIamV1SetIamPolicyRequest" }, - "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "featureStatsAndAnomalySpec.latestStatsCount": { - "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "featureStatsAndAnomalySpec.statsTimeRange.endTime": { - "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "featureStatsAndAnomalySpec.statsTimeRange.startTime": { - "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "streamingFetchFeatureValues": { + "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" + "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists Features in a given FeatureGroup.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.list", + "sync": { + "description": "Triggers on-demand sync for the FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", "parameterOrder": [ - "parent" + "featureView" ], "parameters": { - "filter": { - "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", - "location": "query", - "type": "string" - }, - "latestStatsCount": { - "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "featureView": { + "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+parent}/features", + "path": "v1beta1/{+featureView}:sync", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureGroups.features.patch", + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", "parameterOrder": [ - "name" + "resource" ], "parameters": { - "name": { - "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "required": true, + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "location": "query", + "repeated": true, "type": "string" }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", - "format": "google-fieldmask", - "location": "query", + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, + "path": "v1beta1/{+resource}:testIamPermissions", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17038,13 +18906,88 @@ } }, "resources": { + "featureViewSyncs": { + "methods": { + "get": { + "description": "Gets details of a single FeatureViewSync.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureViewSyncs in a given FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureViewSyncs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", "parameterOrder": [ "name" ], @@ -17052,7 +18995,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17067,9 +19010,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", "parameterOrder": [ "name" ], @@ -17077,7 +19020,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17092,9 +19035,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.list", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list", "parameterOrder": [ "name" ], @@ -17107,7 +19050,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" }, @@ -17138,9 +19081,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.features.operations.wait", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", "parameterOrder": [ "name" ], @@ -17148,7 +19091,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -17175,9 +19118,9 @@ "methods": { "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", "parameterOrder": [ "name" ], @@ -17185,7 +19128,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17200,9 +19143,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.get", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", "parameterOrder": [ "name" ], @@ -17210,7 +19153,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -17225,9 +19168,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.list", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.list", "parameterOrder": [ "name" ], @@ -17240,7 +19183,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", "required": true, "type": "string" }, @@ -17271,9 +19214,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", "parameterOrder": [ "name" ], @@ -17281,7 +19224,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -17304,33 +19247,61 @@ } } }, - "featureOnlineStores": { + "featurestores": { "methods": { + "batchReadFeatureValues": { + "description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", + "parameterOrder": [ + "featurestore" + ], + "parameters": { + "featurestore": { + "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featurestore}:batchReadFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { - "description": "Creates a new FeatureOnlineStore in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "description": "Creates a new Featurestore in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.create", + "id": "aiplatform.projects.locations.featurestores.create", "parameterOrder": [ "parent" ], "parameters": { - "featureOnlineStoreId": { - "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "featurestoreId": { + "description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/featureOnlineStores", + "path": "v1beta1/{+parent}/featurestores", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17340,23 +19311,23 @@ ] }, "delete": { - "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "id": "aiplatform.projects.locations.featurestores.delete", "parameterOrder": [ "name" ], "parameters": { "force": { - "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", + "description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)", "location": "query", "type": "boolean" }, "name": { - "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } @@ -17370,25 +19341,25 @@ ] }, "get": { - "description": "Gets details of a single FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Gets details of a single Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.get", + "id": "aiplatform.projects.locations.featurestores.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureOnlineStore resource.", + "description": "Required. The name of the Featurestore resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17396,28 +19367,25 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.getIamPolicy", + "id": "aiplatform.projects.locations.featurestores.getIamPolicy", "parameterOrder": [ "resource" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+resource}:getIamPolicy", + "request": { + "$ref": "GoogleIamV1GetIamPolicyRequest" + }, "response": { "$ref": "GoogleIamV1Policy" }, @@ -17426,69 +19394,75 @@ ] }, "list": { - "description": "Lists FeatureOnlineStores in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "description": "Lists Featurestores in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.list", + "id": "aiplatform.projects.locations.featurestores.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", + "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", "location": "query", "type": "string" }, "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", + "description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/featureOnlineStores", + "path": "v1beta1/{+parent}/featurestores", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "description": "Updates the parameters of a single Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "id": "aiplatform.projects.locations.featurestores.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", + "description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -17496,7 +19470,7 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + "$ref": "GoogleCloudAiplatformV1beta1Featurestore" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17505,11 +19479,52 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "searchFeatures": { + "description": "Searches Features matching a query in a given project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.searchFeatures", + "parameterOrder": [ + "location" + ], + "parameters": { + "location": { + "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "query": { + "description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+location}/featurestores:searchFeatures", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.setIamPolicy", + "id": "aiplatform.projects.locations.featurestores.setIamPolicy", "parameterOrder": [ "resource" ], @@ -17517,7 +19532,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } @@ -17535,28 +19550,25 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.testIamPermissions", + "id": "aiplatform.projects.locations.featurestores.testIamPermissions", "parameterOrder": [ "resource" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, "response": { "$ref": "GoogleIamV1TestIamPermissionsResponse" }, @@ -17566,38 +19578,33 @@ } }, "resources": { - "featureViews": { + "entityTypes": { "methods": { "create": { - "description": "Creates a new FeatureView in a given FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "description": "Creates a new EntityType in a given Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "id": "aiplatform.projects.locations.featurestores.entityTypes.create", "parameterOrder": [ "parent" ], "parameters": { - "featureViewId": { - "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "entityTypeId": { + "description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" - }, - "runSyncImmediately": { - "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", - "location": "query", - "type": "boolean" } }, - "path": "v1beta1/{+parent}/featureViews", + "path": "v1beta1/{+parent}/entityTypes", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -17607,18 +19614,23 @@ ] }, "delete": { - "description": "Deletes a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", + "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", "parameterOrder": [ "name" ], "parameters": { + "force": { + "description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)", + "location": "query", + "type": "boolean" + }, "name": { - "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } @@ -17631,110 +19643,82 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "directWrite": { - "description": "Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:directWrite", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:directWrite", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewDirectWriteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "fetchFeatureValues": { - "description": "Fetch feature values under a FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", + "deleteFeatureValues": { + "description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", + "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", "parameterOrder": [ - "featureView" + "entityType" ], "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "entityType": { + "description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+featureView}:fetchFeatureValues", + "path": "v1beta1/{+entityType}:deleteFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" + "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "generateFetchAccessToken": { - "description": "RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:generateFetchAccessToken", + "exportFeatureValues": { + "description": "Exports Feature values from all the entities of a target EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken", + "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", "parameterOrder": [ - "featureView" + "entityType" ], "parameters": { - "featureView": { - "description": "FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "entityType": { + "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+featureView}:generateFetchAccessToken", + "path": "v1beta1/{+entityType}:exportFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenRequest" + "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1GenerateFetchAccessTokenResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets details of a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Gets details of a single EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", + "id": "aiplatform.projects.locations.featurestores.entityTypes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17742,9 +19726,9 @@ }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.getIamPolicy", + "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", "parameterOrder": [ "resource" ], @@ -17758,7 +19742,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } @@ -17771,70 +19755,104 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "importFeatureValues": { + "description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", + "parameterOrder": [ + "entityType" + ], + "parameters": { + "entityType": { + "description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+entityType}:importFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { - "description": "Lists FeatureViews in a given FeatureOnlineStore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "description": "Lists EntityTypes in a given Featurestore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", + "id": "aiplatform.projects.locations.featurestores.entityTypes.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", + "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.", "location": "query", "type": "string" }, "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", + "description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", "required": true, "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/featureViews", + "path": "v1beta1/{+parent}/entityTypes", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" + "$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { - "description": "Updates the parameters of a single FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "description": "Updates the parameters of a single EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", + "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources`", + "description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -17842,38 +19860,38 @@ }, "path": "v1beta1/{+name}", "request": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1EntityType" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "searchNearestEntities": { - "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", + "readFeatureValues": { + "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", + "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", "parameterOrder": [ - "featureView" + "entityType" ], "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "entityType": { + "description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+featureView}:searchNearestEntities", + "path": "v1beta1/{+entityType}:readFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17881,9 +19899,9 @@ }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy", + "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", "parameterOrder": [ "resource" ], @@ -17891,7 +19909,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } @@ -17907,57 +19925,29 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "streamingFetchFeatureValues": { - "description": "Bidirectional streaming RPC to fetch feature values under a FeatureView. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:streamingFetchFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.streamingFetchFeatureValues", - "parameterOrder": [ - "featureView" - ], - "parameters": { - "featureView": { - "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featureView}:streamingFetchFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingFetchFeatureValuesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "sync": { - "description": "Triggers on-demand sync for the FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "streamingReadFeatureValues": { + "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", + "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", "parameterOrder": [ - "featureView" + "entityType" ], "parameters": { - "featureView": { - "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "entityType": { + "description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+featureView}:sync", + "path": "v1beta1/{+entityType}:streamingReadFeatureValues", "request": { - "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" + "$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" + "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -17965,9 +19955,9 @@ }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions", + "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", "parameterOrder": [ "resource" ], @@ -17981,7 +19971,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" } @@ -17993,879 +19983,648 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "featureViewSyncs": { - "methods": { - "get": { - "description": "Gets details of a single FeatureViewSync.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists FeatureViewSyncs in a given FeatureView.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featureViewSyncs", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/operations/{operationsId}:wait", + "writeFeatureValues": { + "description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureOnlineStores.operations.wait", + "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", "parameterOrder": [ - "name" + "entityType" ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "entityType": { + "description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+entityType}:writeFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "featurestores": { - "methods": { - "batchReadFeatureValues": { - "description": "Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:batchReadFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.batchReadFeatureValues", - "parameterOrder": [ - "featurestore" - ], - "parameters": { - "featurestore": { - "description": "Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+featurestore}:batchReadFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchReadFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Featurestore in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featurestoreId": { - "description": "Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to create Featurestores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featurestores", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the Featurestore to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Featurestore resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "request": { - "$ref": "GoogleIamV1GetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Featurestores in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` Featurestores created or updated after 2020-01-01. * `labels.env = \"prod\"` Featurestores with label \"env\" set to \"prod\".", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Featurestores. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/featurestores", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturestoresResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days`", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Featurestore" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "searchFeatures": { - "description": "Searches Features matching a query in a given project.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores:searchFeatures", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.searchFeatures", - "parameterOrder": [ - "location" - ], - "parameters": { - "location": { - "description": "Required. The resource name of the Location to search Features. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "query": { - "description": "Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks (\"). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = \"foo bar\"` --> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with `env` as the key.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+location}/featurestores:searchFeatures", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1SearchFeaturesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "entityTypes": { - "methods": { - "create": { - "description": "Creates a new EntityType in a given Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "entityTypeId": { - "description": "Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore.", - "location": "query", - "type": "string" + "resources": { + "features": { + "methods": { + "batchCreate": { + "description": "Creates a batch of Features in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features:batchCreate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new Feature in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "featureStatsAndAnomalySpec.latestStatsCount": { + "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "featureStatsAndAnomalySpec.statsTimeRange.endTime": { + "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "featureStatsAndAnomalySpec.statsTimeRange.startTime": { + "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given EntityType.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, - "path": "v1beta1/{+parent}/entityTypes", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "force": { - "description": "If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.)", - "location": "query", - "type": "boolean" - }, - "name": { - "description": "Required. The name of the EntityType to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "deleteFeatureValues": { - "description": "Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:deleteFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues", - "parameterOrder": [ - "entityType" - ], - "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1beta1/{+entityType}:deleteFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeleteFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "exportFeatureValues": { - "description": "Exports Feature values from all the entities of a target EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:exportFeatureValues", + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues", - "parameterOrder": [ - "entityType" - ], - "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+entityType}:exportFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ExportFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.get", + "id": "aiplatform.projects.locations.featurestores.operations.cancel", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the EntityType resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:getIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.getIamPolicy", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featurestores.operations.delete", "parameterOrder": [ - "resource" + "name" ], "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.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1Policy" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "importFeatureValues": { - "description": "Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:importFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featurestores.operations.get", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:importFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportFeatureValuesRequest" - }, + "path": "v1beta1/{+name}", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -18874,784 +20633,717 @@ ] }, "list": { - "description": "Lists EntityTypes in a given Featurestore.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes", + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.list", + "id": "aiplatform.projects.locations.featurestores.operations.list", "parameterOrder": [ - "parent" + "name" ], "parameters": { "filter": { - "description": "Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any EntityType which has a label with 'env' as the key.", + "description": "The standard list filter.", "location": "query", "type": "string" }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time`", - "location": "query", + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "required": true, "type": "string" }, "pageSize": { - "description": "The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token.", + "description": "The standard list page token.", "location": "query", "type": "string" }, - "parent": { - "description": "Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", - "type": "string" + "type": "boolean" } }, - "path": "v1beta1/{+parent}/entityTypes", + "path": "v1beta1/{+name}/operations", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListEntityTypesResponse" + "$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.entityTypes.patch", + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featurestores.operations.wait", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Immutable. Name of the EntityType. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore.", + "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days`", - "format": "google-fieldmask", + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" - }, + "path": "v1beta1/{+name}:wait", "response": { - "$ref": "GoogleCloudAiplatformV1beta1EntityType" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + } + } + } + } + }, + "hyperparameterTuningJobs": { + "methods": { + "cancel": { + "description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" + }, + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a HyperparameterTuningJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/hyperparameterTuningJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a HyperparameterTuningJob.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a HyperparameterTuningJob", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists HyperparameterTuningJobs in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "location": "query", + "type": "string" }, - "readFeatureValues": { - "description": "Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:readFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues", - "parameterOrder": [ - "entityType" - ], - "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+entityType}:readFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:setIamPolicy", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", + "location": "query", + "type": "string" }, - "streamingReadFeatureValues": { - "description": "Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:streamingReadFeatureValues", + "parent": { + "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/hyperparameterTuningJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the entities' type. Value format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:streamingReadFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1StreamingReadFeatureValuesRequest" - }, + "path": "v1beta1/{+name}:cancel", "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadFeatureValuesResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:testIamPermissions", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions", + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "location": "query", - "repeated": true, - "type": "string" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "writeFeatureValues": { - "description": "Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}:writeFeatureValues", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues", + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", "parameterOrder": [ - "entityType" + "name" ], "parameters": { - "entityType": { - "description": "Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project}/locations/{location}/featurestores/ {featurestore}/entityTypes/{entityType}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`.", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+entityType}:writeFeatureValues", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesRequest" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1WriteFeatureValuesResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - }, - "resources": { - "features": { - "methods": { - "batchCreate": { - "description": "Creates a batch of Features in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features:batchCreate", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features:batchCreate", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new Feature in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" }, - "get": { - "description": "Gets details of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "featureStatsAndAnomalySpec.latestStatsCount": { - "description": "Optional. If set, returns the most recent count of stats. Valid value is [0, 100]. If stats_time_range is set, return most recent count of stats within the stats_time_range.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "featureStatsAndAnomalySpec.statsTimeRange.endTime": { - "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "featureStatsAndAnomalySpec.statsTimeRange.startTime": { - "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "location": "query", - "type": "string" - }, - "name": { - "description": "Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "required": true, + "type": "string" }, - "list": { - "description": "Lists Features in a given EntityType.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", - "location": "query", - "type": "string" - }, - "latestStatsCount": { - "description": "Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "orderBy": { - "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` Format for feature_group as parent: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/features", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "patch": { - "description": "Updates the parameters of a single Feature.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Feature" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "pageToken": { + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" } }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/features/{featuresId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "indexEndpoints": { + "methods": { + "create": { + "description": "Creates an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/indexEndpoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexEndpoints.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "deployIndex": { + "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:deployIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "findNeighbors": { + "description": "Finds the nearest neighbors of each vector within the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:findNeighbors", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists IndexEndpoints in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexEndpoints.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" }, - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/entityTypes/{entityTypesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.entityTypes.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } - } + }, + "path": "v1beta1/{+parent}/indexEndpoints", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "mutateDeployedIndex": { + "description": "Update an existing DeployedIndex under an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an IndexEndpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexEndpoints.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the IndexEndpoint.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "readIndexDatapoints": { + "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:readIndexDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, + "undeployIndex": { + "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", + "parameterOrder": [ + "indexEndpoint" + ], + "parameters": { + "indexEndpoint": { + "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+indexEndpoint}:undeployIndex", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.operations.cancel", + "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", "parameterOrder": [ "name" ], @@ -19659,7 +21351,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19674,9 +21366,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featurestores.operations.delete", + "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", "parameterOrder": [ "name" ], @@ -19684,7 +21376,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19699,9 +21391,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.operations.get", + "id": "aiplatform.projects.locations.indexEndpoints.operations.get", "parameterOrder": [ "name" ], @@ -19709,7 +21401,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19724,9 +21416,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featurestores.operations.list", + "id": "aiplatform.projects.locations.indexEndpoints.operations.list", "parameterOrder": [ "name" ], @@ -19739,7 +21431,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" }, @@ -19770,9 +21462,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featurestores/{featurestoresId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featurestores.operations.wait", + "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", "parameterOrder": [ "name" ], @@ -19780,7 +21472,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -19803,125 +21495,125 @@ } } }, - "hyperparameterTuningJobs": { + "indexes": { "methods": { - "cancel": { - "description": "Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}:cancel", + "create": { + "description": "Creates an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.cancel", + "id": "aiplatform.projects.locations.indexes.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "parent": { + "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+parent}/indexes", "request": { - "$ref": "GoogleCloudAiplatformV1beta1CancelHyperparameterTuningJobRequest" + "$ref": "GoogleCloudAiplatformV1beta1Index" }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "create": { - "description": "Creates a HyperparameterTuningJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.create", + "delete": { + "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.indexes.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project}/locations/{location}`", + "name": { + "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+parent}/hyperparameterTuningJobs", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" - }, + "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "delete": { - "description": "Deletes a HyperparameterTuningJob.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.delete", + "get": { + "description": "Gets an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.indexes.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Index" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets a HyperparameterTuningJob", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.get", + "import": { + "description": "Imports an Index from an external source (e.g., BigQuery).", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.import", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}`", + "description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}", + "path": "v1beta1/{+name}:import", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists HyperparameterTuningJobs in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs", + "description": "Lists Indexes in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.list", + "id": "aiplatform.projects.locations.indexes.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`>`, `>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state=\"JOB_STATE_SUCCEEDED\" AND display_name:\"my_job_*\"` * `state!=\"JOB_STATE_FAILED\" OR display_name=\"my_job\"` * `NOT display_name=\"my_job\"` * `create_time>\"2021-05-18T00:00:00Z\"` * `labels.keyA=valueA` * `labels.keyB:*`", + "description": "The standard list filter.", "location": "query", "type": "string" }, @@ -19932,27 +21624,117 @@ "type": "integer" }, "pageToken": { - "description": "The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call.", + "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project}/locations/{location}`", + "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/indexes", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.indexes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the Index.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Index" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "removeDatapoints": { + "description": "Remove Datapoints from an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.removeDatapoints", + "parameterOrder": [ + "index" + ], + "parameters": { + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+index}:removeDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upsertDatapoints": { + "description": "Add/update Datapoints into an Index.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.indexes.upsertDatapoints", + "parameterOrder": [ + "index" + ], + "parameters": { + "index": { + "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+parent}/hyperparameterTuningJobs", + "path": "v1beta1/{+index}:upsertDatapoints", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" + }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse" + "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -19964,9 +21746,9 @@ "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel", + "id": "aiplatform.projects.locations.indexes.operations.cancel", "parameterOrder": [ "name" ], @@ -19974,7 +21756,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -19989,9 +21771,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete", + "id": "aiplatform.projects.locations.indexes.operations.delete", "parameterOrder": [ "name" ], @@ -19999,7 +21781,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20014,9 +21796,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.get", + "id": "aiplatform.projects.locations.indexes.operations.get", "parameterOrder": [ "name" ], @@ -20024,7 +21806,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20039,9 +21821,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.list", + "id": "aiplatform.projects.locations.indexes.operations.list", "parameterOrder": [ "name" ], @@ -20054,7 +21836,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", "required": true, "type": "string" }, @@ -20085,9 +21867,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/hyperparameterTuningJobs/{hyperparameterTuningJobsId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait", + "id": "aiplatform.projects.locations.indexes.operations.wait", "parameterOrder": [ "name" ], @@ -20095,7 +21877,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/hyperparameterTuningJobs/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -20118,299 +21900,121 @@ } } }, - "indexEndpoints": { + "interactions": { "methods": { "create": { - "description": "Creates an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", + "description": "Creates an interaction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/indexEndpoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexEndpoints.delete", + "id": "aiplatform.projects.locations.interactions.create", "parameterOrder": [ - "name" + "projectsId", + "locationsId" ], "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "locationsId": { "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "deployIndex": { - "description": "Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:deployIndex", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.deployIndex", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + }, + "projectsId": { "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+indexEndpoint}:deployIndex", + "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployIndexRequest" + "$ref": "GenaiVertexV1beta1CreateInteractionRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GenaiVertexV1beta1Interaction" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "findNeighbors": { - "description": "Finds the nearest neighbors of each vector within the request.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:findNeighbors", + "createStream": { + "description": "Creates an interaction and streams the response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.findNeighbors", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+indexEndpoint}:findNeighbors", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1FindNeighborsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the IndexEndpoint resource. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists IndexEndpoints in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.list", + "id": "aiplatform.projects.locations.interactions.createStream", "parameterOrder": [ - "parent" + "projectsId", + "locationsId" ], "parameters": { - "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `index_endpoint=\"1\"` * `display_name=\"myDisplayName\"` * `regex(display_name, \"^A\") -> The display name starts with an A. * `labels.myKey=\"myValue\"`", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project}/locations/{location}`", + "locationsId": { "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "readMask": { - "description": "Optional. Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/indexEndpoints", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListIndexEndpointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "mutateDeployedIndex": { - "description": "Update an existing DeployedIndex under an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:mutateDeployedIndex", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "projectsId": { "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+indexEndpoint}:mutateDeployedIndex", + "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", "request": { - "$ref": "GoogleCloudAiplatformV1beta1DeployedIndex" + "$ref": "GenaiVertexV1beta1CreateInteractionRequest" }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates an IndexEndpoint.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.indexEndpoints.patch", + "delete": { + "description": "Deletes an interaction.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions/{interactionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.interactions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The resource name of the IndexEndpoint.", + "description": "Required. The name of the interaction to delete. Format: interactions/{interaction}", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/interactions/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Required. The update mask applies to the resource. See google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1IndexEndpoint" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "readIndexDatapoints": { - "description": "Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:readIndexDatapoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.readIndexDatapoints", - "parameterOrder": [ - "indexEndpoint" - ], - "parameters": { - "indexEndpoint": { - "description": "Required. The name of the index endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+indexEndpoint}:readIndexDatapoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsRequest" - }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReadIndexDatapointsResponse" + "$ref": "GenaiVertexV1beta1DeleteInteractionResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "undeployIndex": { - "description": "Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}:undeployIndex", + } + } + }, + "memoryBanks": { + "methods": { + "ingestEvents": { + "description": "Ingests events for a Memory Bank.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}:ingestEvents", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.undeployIndex", + "id": "aiplatform.projects.locations.memoryBanks.ingestEvents", "parameterOrder": [ - "indexEndpoint" + "parent" ], "parameters": { - "indexEndpoint": { - "description": "Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "parent": { + "description": "Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+indexEndpoint}:undeployIndex", + "path": "v1beta1/{+parent}:ingestEvents", "request": { - "$ref": "GoogleCloudAiplatformV1beta1UndeployIndexRequest" + "$ref": "GoogleCloudAiplatformV1beta1IngestEventsRequest" }, "response": { "$ref": "GoogleLongrunningOperation" @@ -20421,153 +22025,304 @@ } }, "resources": { - "operations": { + "memories": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:cancel", + "create": { + "description": "Create a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.operations.cancel", + "id": "aiplatform.projects.locations.memoryBanks.memories.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "memoryId": { + "description": "Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:cancel", + "path": "v1beta1/{+parent}/memories", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "description": "Delete a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexEndpoints.operations.delete", + "id": "aiplatform.projects.locations.memoryBanks.memories.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The resource name of the Memory to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generate": { + "description": "Generate memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:generate", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.generate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:generate", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}", + "description": "Get a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.operations.get", + "id": "aiplatform.projects.locations.memoryBanks.memories.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1Memory" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations", + "description": "List Memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexEndpoints.operations.list", + "id": "aiplatform.projects.locations.memoryBanks.memories.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: \"example topic\" OR topics.managed_memory_topic: USER_PREFERENCES`)", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", "location": "query", "type": "string" }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.memoryBanks.memories.patch", + "parameterOrder": [ + "name" + ], + "parameters": { "name": { - "description": "The name of the operation's parent resource.", + "description": "Identifier. Represents the resource name of the Memory. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Memory" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "purge": { + "description": "Purge memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:purge", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:purge", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PurgeMemoriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieve": { + "description": "Retrieve memories.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieve", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.retrieve", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/memories:retrieve", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveMemoriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "retrieveProfiles": { + "description": "Retrieves profiles.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories:retrieveProfiles", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.retrieveProfiles", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine to retrieve profiles from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1beta1/{+parent}/memories:retrieveProfiles", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesRequest" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleCloudAiplatformV1beta1RetrieveProfilesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexEndpoints/{indexEndpointsId}/operations/{operationsId}:wait", + "rollback": { + "description": "Rollback Memory to a specific revision.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}:rollback", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexEndpoints.operations.wait", + "id": "aiplatform.projects.locations.memoryBanks.memories.rollback", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to wait on.", + "description": "Required. The resource name of the Memory to rollback. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexEndpoints/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+name}:rollback", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RollbackMemoryRequest" + }, "response": { "$ref": "GoogleLongrunningOperation" }, @@ -20575,264 +22330,243 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "indexes": { - "methods": { - "create": { - "description": "Creates an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the Location to create the Index in. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+parent}/indexes", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Index" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Index resource to be deleted. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Index resource. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1Index" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "import": { - "description": "Imports an Index from an external source (e.g., BigQuery).", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:import", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.import", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the Index resource to import data to. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:import", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1ImportIndexRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Indexes in a Location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project}/locations/{location}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - }, - "readMask": { - "description": "Mask specifying which fields to read.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+parent}/indexes", - "response": { - "$ref": "GoogleCloudAiplatformV1beta1ListIndexesResponse" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}", - "httpMethod": "PATCH", - "id": "aiplatform.projects.locations.indexes.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name of the Index.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + }, + "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.memoryBanks.memories.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "updateMask": { - "description": "The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1Index" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "removeDatapoints": { - "description": "Remove Datapoints from an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:removeDatapoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.removeDatapoints", - "parameterOrder": [ - "index" - ], - "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" + "revisions": { + "methods": { + "get": { + "description": "Get a Memory Revision.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions/{revisionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}/revisions/{revision}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+/revisions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryRevision" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List Memory Revisions for a Memory.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/memories/{memoriesId}/revisions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.memoryBanks.memories.revisions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Memory to list revisions for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/memories/{memory}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/memories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/revisions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMemoryRevisionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } - }, - "path": "v1beta1/{+index}:removeDatapoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1RemoveDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, - "upsertDatapoints": { - "description": "Add/update Datapoints into an Index.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}:upsertDatapoints", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.upsertDatapoints", - "parameterOrder": [ - "index" - ], - "parameters": { - "index": { - "description": "Required. The name of the Index resource to be updated. Format: `projects/{project}/locations/{location}/indexes/{index}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+index}:upsertDatapoints", - "request": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsRequest" - }, - "response": { - "$ref": "GoogleCloudAiplatformV1beta1UpsertDatapointsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { "operations": { "methods": { "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:cancel", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:cancel", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.operations.cancel", + "id": "aiplatform.projects.locations.memoryBanks.operations.cancel", "parameterOrder": [ "name" ], @@ -20840,7 +22574,7 @@ "name": { "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20855,9 +22589,9 @@ }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.indexes.operations.delete", + "id": "aiplatform.projects.locations.memoryBanks.operations.delete", "parameterOrder": [ "name" ], @@ -20865,7 +22599,7 @@ "name": { "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20880,9 +22614,9 @@ }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.operations.get", + "id": "aiplatform.projects.locations.memoryBanks.operations.get", "parameterOrder": [ "name" ], @@ -20890,7 +22624,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -20905,9 +22639,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations", "httpMethod": "GET", - "id": "aiplatform.projects.locations.indexes.operations.list", + "id": "aiplatform.projects.locations.memoryBanks.operations.list", "parameterOrder": [ "name" ], @@ -20920,7 +22654,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+$", "required": true, "type": "string" }, @@ -20951,9 +22685,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/indexes/{indexesId}/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/memoryBanks/{memoryBanksId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.indexes.operations.wait", + "id": "aiplatform.projects.locations.memoryBanks.operations.wait", "parameterOrder": [ "name" ], @@ -20961,7 +22695,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/indexes/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/memoryBanks/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -20984,74 +22718,6 @@ } } }, - "interactions": { - "methods": { - "create": { - "description": "Creates an interaction.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.interactions.create", - "parameterOrder": [ - "projectsId", - "locationsId" - ], - "parameters": { - "locationsId": { - "location": "path", - "required": true, - "type": "string" - }, - "projectsId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:create", - "request": { - "$ref": "GenaiVertexV1beta1CreateInteractionRequest" - }, - "response": { - "$ref": "GenaiVertexV1beta1Interaction" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "createStream": { - "description": "Creates an interaction and streams the response.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.interactions.createStream", - "parameterOrder": [ - "projectsId", - "locationsId" - ], - "parameters": { - "locationsId": { - "location": "path", - "required": true, - "type": "string" - }, - "projectsId": { - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/projects/{projectsId}/locations/{locationsId}/interactions:createStream", - "request": { - "$ref": "GenaiVertexV1beta1CreateInteractionRequest" - }, - "response": { - "$ref": "GenaiVertexV1beta1InteractionStreamingEvent" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "metadataStores": { "methods": { "create": { @@ -24880,6 +26546,347 @@ } } }, + "monitoredAgents": { + "methods": { + "disable": { + "description": "Disables a specific MonitoredAgent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:disable", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.monitoredAgents.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the MonitoredAgent resource to be disabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:disable", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enables a specific MonitoredAgent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}:enable", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.monitoredAgents.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the MonitoredAgent resource to be enabled. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:enable", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific MonitoredAgent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1MonitoredAgent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MonitoredAgents in a specific Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An AIP-160 filter, currently restricted to a single equality predicate on `state`. The value must be the exact, case-sensitive name of a `MonitoredAgent.EnablementState` value: `ACTIVE`, `DISABLED`, `ENABLING`, or `ENABLEMENT_STATE_UNSPECIFIED`. A blank or absent filter returns every MonitoredAgent in the parent regardless of state; any other value returns `INVALID_ARGUMENT`. Example: ``` state = ACTIVE ```", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the MonitoredAgents from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/monitoredAgents", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "analyzedSessions": { + "methods": { + "aggregate": { + "description": "Aggregates AnalyzedSessions across MonitoredAgents. To aggregate across all MonitoredAgents in a location, use the following format for the parent field: `projects/{project}/locations/{location}/monitoredAgents/-`", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions:aggregate", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.aggregate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression restricting which AnalyzedSessions are included in the aggregation. Supports a subset of the `ListAnalyzedSessionsRequest.filter` grammar: a closed `detection_time` window with both bounds required. The `severity` clause is not supported here. If empty, the aggregation covers the last 3 days. Example: ``` detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" ```", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size. The maximum value is 100; values above 100 will be coerced to 100. If unspecified, at most 10 MonitoredAgents will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent MonitoredAgent resource. Use the `-` wildcard for the monitored_agent segment to aggregate across multiple agents in the location. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/analyzedSessions:aggregate", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific AnalyzedSession.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Resource view to control which fields are returned.", + "enum": [ + "ANALYZED_SESSION_VIEW_UNSPECIFIED", + "ANALYZED_SESSION_VIEW_BASIC", + "ANALYZED_SESSION_VIEW_FULL" + ], + "enumDescriptions": [ + "The default view: BASIC.", + "Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", + "Full view includes all fields, including the detailed assessment." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSession" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AnalyzedSessions in a MonitoredAgent.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter expression restricting which AnalyzedSessions are returned. Supports a subset of AIP-160: a closed `detection_time` window (both bounds required) and/or an equality on `severity`, joined by `AND`. Each clause is optional, may appear at most once, and may appear in either order. The `severity` value is the string form of a `Severity` value (`CRITICAL`, `HIGH`, `MEDIUM`, or `LOW`; `SEVERITY_UNSPECIFIED` is not supported) and matches sessions whose maximum severity equals that bucket. For example, a session that fires at both LOW and CRITICAL matches `severity = \"CRITICAL\"`, not `severity = \"LOW\"`. Example (time window and severity): ``` detection_time >= \"2024-01-01T00:00:00Z\" AND detection_time <= \"2024-01-08T00:00:00Z\" AND severity = \"CRITICAL\" ``` If empty, results are restricted to the last 3 days with no severity restriction. Other fields, additional operators, set membership (`IN`), and boolean combinations (`OR`, `NOT`, parentheses) are not yet supported.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Comma-separated list of fields to sort by, following AIP-132 syntax. The default sort direction is ascending; append \" desc\" to a field to sort descending. Supported fields (any other field yields INVALID_ARGUMENT): * `latest_detection_time` - the session's most-recent flagged detection time. `latest_detection_time desc` puts the newest sessions first. * `max_severity_rank` - the session's bucketed maximum severity, ranked LOW=1 < MEDIUM=2 < HIGH=3 < CRITICAL=4. `max_severity_rank desc` puts the most-severe sessions first. * `agent_display_name` - the MonitoredAgent's display name. Sorted as a STRING (case-sensitive, code-point order). If empty, defaults to `latest_detection_time desc`. Multi-field sort (for example, `max_severity_rank desc, latest_detection_time desc`) is supported. The `order_by` value MUST match the value used on the call that minted any supplied `page_token` (AIP-158). Mismatches yield INVALID_ARGUMENT.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of analyzed sessions to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAnalyzedSessions` call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent MonitoredAgent resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. Resource view to control which fields are returned.", + "enum": [ + "ANALYZED_SESSION_VIEW_UNSPECIFIED", + "ANALYZED_SESSION_VIEW_BASIC", + "ANALYZED_SESSION_VIEW_FULL" + ], + "enumDescriptions": [ + "The default view: BASIC.", + "Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", + "Full view includes all fields, including the detailed assessment." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/analyzedSessions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "analyzedInvocations": { + "methods": { + "get": { + "description": "Gets the details of a specific AnalyzedInvocation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations/{analyzedInvocationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the AnalyzedInvocation resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}/analyzedInvocations/{analyzed_invocation}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+/analyzedInvocations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedInvocation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AnalyzedInvocations in a MonitoredAgent's AnalyzedSession.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/monitoredAgents/{monitoredAgentsId}/analyzedSessions/{analyzedSessionsId}/analyzedInvocations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.monitoredAgents.analyzedSessions.analyzedInvocations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of analyzed invocations to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAnalyzedInvocations` call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent AnalyzedSession resource. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}/analyzedSessions/{analyzed_session}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/monitoredAgents/[^/]+/analyzedSessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/analyzedInvocations", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "nasJobs": { "methods": { "cancel": { @@ -26463,7 +28470,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 50 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.", + "description": "Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158.", "format": "int32", "location": "query", "type": "integer" @@ -28075,6 +30082,136 @@ } } } + }, + "v1": { + "methods": { + "responses": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.v1.responses", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/v1/responses", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + }, + "resources": { + "responses": { + "methods": { + "compact": { + "description": "Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/compact", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.publishers.v1.responses.compact", + "parameterOrder": [ + "endpoint" + ], + "parameters": { + "deployedModelId": { + "description": "ID of the DeployedModel that serves the invoke request.", + "location": "query", + "type": "string" + }, + "endpoint": { + "description": "Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+endpoint}/v1/responses/compact", + "request": { + "$ref": "GoogleApiHttpBody" + }, + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "delete": { + "description": "Deletes the response from the endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.publishers.v1.responses.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Response resource to be deleted. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "get": { + "description": "Gets the response from the endpoint.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/publishers/{publishersId}/v1/responses/{responsesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.publishers.v1.responses.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Response resource. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}/responses/{response}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/v1/responses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + } + } } } }, @@ -30489,7 +32626,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", + "description": "Required. The resource name of the A2aTask to append events to. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -30517,12 +32654,12 @@ ], "parameters": { "a2aTaskId": { - "description": "Required. User-defined ID of the A2aTask. This ID must be unique within the ReasoningEngine. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", + "description": "Required. User-defined ID of the A2aTask. This ID must be unique within the parent resource. It must be 1-63 characters, start with a lowercase letter or number, end with a lowercase letter or number, and only contain lowercase letters, numbers, and hyphens [AIP-122](https://google.aip.dev/122). Starting with a number is allowed for compatibility with the auto-generated UUID from A2A SDK.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the ReasoningEngine to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the ReasoningEngine or TaskStore to create the A2aTask under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -30550,7 +32687,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", + "description": "Required. The resource name of the A2aTask to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -30575,11 +32712,26 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", + "description": "Required. The resource name of the A2aTask. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. The view of the A2aTask to return.", + "enum": [ + "A2A_TASK_VIEW_UNSPECIFIED", + "A2A_TASK_VIEW_BASIC", + "A2A_TASK_VIEW_FULL" + ], + "enumDescriptions": [ + "Task view unspecified.", + "Task header only (status, metadata, timestamps)", + "Full materialized state (artifacts + history)" + ], + "location": "query", + "type": "string" } }, "path": "v1beta1/{+name}", @@ -30616,12 +32768,12 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTasks call.", + "description": "Optional. The next_page_token value returned from a previous list ListA2aTasks call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the ReasoningEngine to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "description": "Required. The resource name of the ReasoningEngine or TaskStore to list the A2aTasks under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` or `projects/{project}/locations/{location}/taskStores/{task_store}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", "required": true, @@ -30666,12 +32818,12 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list AgentEngineTaskStoreService.ListA2aTaskEvents call.", + "description": "Optional. The next_page_token value returned from a previous list ListA2aTaskEvents call.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", + "description": "Required. The resource name of the A2aTask to list the TaskEvents under. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/a2aTasks/[^/]+$", "required": true, @@ -30805,6 +32957,225 @@ } }, "feedbackEntries": { + "methods": { + "create": { + "description": "Creates a new FeedbackEntry.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the ReasoningEngine in which to create the FeedbackEntry. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackEntries", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a FeedbackEntry and its associated FeedbackContext.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the FeedbackEntry to delete. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a single FeedbackEntry by its resource name.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the FeedbackEntry to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getFeedbackContext": { + "description": "Retrieves the FeedbackContext associated with a FeedbackEntry.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.getFeedbackContext", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the FeedbackContext to retrieve. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeedbackEntries in a ReasoningEngine.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard list filter. Supported fields: * `session_id` * `user_id` * `feedback_type` * `feedback_labels`: Supports the HAS operator (`:`). For example: `feedback_labels:\"inaccurate\"`. * `create_time` * `update_time` Example: `feedback_type=\"THUMBS_DOWN\" AND feedback_labels:\"hallucination\"`.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order results by, sorted in ascending order by default. Append ` desc` after a field name to sort that field in descending order. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of FeedbackEntries to return per page.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous ListFeedbackEntries call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the ReasoningEngine from which to list FeedbackEntries. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/feedbackEntries", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackEntry are replaced with the values from feedback_entry.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateFeedbackContext": { + "description": "Updates the FeedbackContext associated with a FeedbackEntry. Only the fields specified in update_mask are modified. If the mask is empty, all mutable fields are replaced with the values supplied in the request.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/feedbackEntries/{feedbackEntriesId}/feedbackContext", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.reasoningEngines.feedbackEntries.updateFeedbackContext", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/feedbackEntries/[^/]+/feedbackContext$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The field mask that controls which fields are updated. If unset or empty, all mutable fields of the FeedbackContext are replaced with the values from feedback_context.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackContext" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -31168,7 +33539,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -33541,6 +35912,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pause": { + "description": "Pauses the specific SandboxEnvironment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes the specific SandboxEnvironment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "snapshot": { "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", @@ -34511,6 +36938,166 @@ } }, "semanticGovernancePolicies": { + "methods": { + "create": { + "description": "Creates a SemanticGovernancePolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "semanticGovernancePolicyId": { + "description": "Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/semanticGovernancePolicies", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SemanticGovernancePolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SemanticGovernancePolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project}/locations/{location}/semanticGovernancePolicies/{semantic_governance_policy}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SemanticGovernancePolicies in a given location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The list page size. If zero, a default page size of 10 is used.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/semanticGovernancePolicies", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SemanticGovernancePolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Resource name of the SemanticGovernancePolicy.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -34637,169 +37224,9 @@ }, "wait": { "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "semanticGovernancePolicyEngine": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine/operations/{operationsId}:wait", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicies/{semanticGovernancePoliciesId}/operations/{operationsId}:wait", "httpMethod": "POST", - "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.operations.wait", + "id": "aiplatform.projects.locations.semanticGovernancePolicies.operations.wait", "parameterOrder": [ "name" ], @@ -34807,7 +37234,7 @@ "name": { "description": "The name of the operation resource to wait on.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicies/[^/]+/operations/[^/]+$", "required": true, "type": "string" }, @@ -34830,7 +37257,194 @@ } } }, + "semanticGovernancePolicyEngine": { + "methods": { + "deprovision": { + "description": "Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/semanticGovernancePolicyEngine:deprovision", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/semanticGovernancePolicyEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:deprovision", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "servingProfiles": { + "methods": { + "create": { + "description": "Creates a ServingProfile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.servingProfiles.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to create the ServingProfile in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "servingProfileId": { + "description": "Required. The ID to use for the ServingProfile, which will become the final component of the ServingProfile's resource name. This value should be 1-63 characters, and valid characters are `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/servingProfiles", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a ServingProfile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.servingProfiles.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ServingProfile resource to be deleted. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a ServingProfile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.servingProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the ServingProfile resource. Format: `projects/{project}/locations/{location}/servingProfiles/{serving_profile}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ServingProfiles in a Location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.servingProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The standard list page size. If unspecified, at most 100 ServingProfiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list the ServingProfiles from. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/servingProfiles", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a ServingProfile.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/servingProfiles/{servingProfilesId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.servingProfiles.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ServingProfile.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/servingProfiles/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. The list of fields to update; see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. If omitted, all populated (non-empty) mutable fields are updated; if set to `[\"*\"]`, all mutable fields are fully replaced (unpopulated values are cleared).", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -35009,7 +37623,7 @@ "type": "string" }, "skillId": { - "description": "Optional. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", + "description": "Required. The ID to use for the Skill, which will become the final component of the Skill's resource name. If not provided, a system-generated ID will be used. This value must be 1-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a lowercase letter, and the last character must be a lowercase letter or a number. Specifically, the ID must match the regular expression: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$` See [AIP-122](https://aip.dev/122#resource-id-segments) for more details.", "location": "query", "type": "string" } @@ -38668,6 +41282,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "processData": { + "description": "Processes data from a user's Cloud Storage bucket and saves the result to a destination Cloud Storage bucket. This method returns a long-running operation, and the `ProcessDataResponse` will be returned upon completion.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:processData", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.processData", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to process the data in. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs:processData", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "rebaseTunedModel": { "description": "Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", @@ -38695,11 +41337,64 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "validateReinforcementTuningReward": { + "description": "Validates a reward on a given example.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:validateReinforcementTuningReward", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.validateReinforcementTuningReward", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location to validate the reward in Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs:validateReinforcementTuningReward", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", @@ -38724,6 +41419,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -41300,7 +44051,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact`", + "description": "Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -43582,6 +46333,62 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "pause": { + "description": "Pauses the specific SandboxEnvironment.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:pause", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to pause. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:pause", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resume": { + "description": "Resumes the specific SandboxEnvironment.", + "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:resume", + "httpMethod": "POST", + "id": "aiplatform.reasoningEngines.sandboxEnvironments.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the sandbox environment to resume. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironments/{sandbox_environment}`", + "location": "path", + "pattern": "^reasoningEngines/[^/]+/sandboxEnvironments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:resume", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "snapshot": { "description": "Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource.", "flatPath": "v1beta1/reasoningEngines/{reasoningEnginesId}/sandboxEnvironments/{sandboxEnvironmentsId}:snapshot", @@ -44495,166 +47302,6 @@ } } }, - "semanticGovernancePolicyEngine": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", - "flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "aiplatform.semanticGovernancePolicyEngine.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}:cancel", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.semanticGovernancePolicyEngine.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.semanticGovernancePolicyEngine.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta1/semanticGovernancePolicyEngine/operations", - "httpMethod": "GET", - "id": "aiplatform.semanticGovernancePolicyEngine.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^semanticGovernancePolicyEngine$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - }, - "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. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1beta1/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/semanticGovernancePolicyEngine/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "aiplatform.semanticGovernancePolicyEngine.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^semanticGovernancePolicyEngine/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1beta1/{+name}:wait", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, "servingProfiles": { "resources": { "operations": { @@ -46363,6 +49010,31 @@ "resources": { "operations": { "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", + "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "aiplatform.tuningJobs.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:cancel", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", @@ -46387,6 +49059,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.tuningJobs.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/tuningJobs/{tuningJobsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.tuningJobs.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -46515,27 +49243,42 @@ } } }, - "revision": "20260515", + "revision": "20260725", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoExperiments": { "description": "Experimental parameters for video generation.", "id": "CloudAiLargeModelsVisionGenerateVideoExperiments", "properties": { + "anchorLastFrame": { + "description": "Optional. If true, anchors the last frame in video generation by generating a custom border mask.", + "type": "boolean" + }, + "cfgScale": { + "description": "CFG scale for video-transform, perf-generation, a2v, video-textures models.", + "format": "float", + "type": "number" + }, "codec": { "description": "Optional. Video codec to use for output.", "enum": [ "VIDEO_CODEC_UNSPECIFIED", "VIDEO_CODEC_H264", - "VIDEO_CODEC_PRORES" + "VIDEO_CODEC_PRORES", + "VIDEO_CODEC_DNXHR" ], "enumDescriptions": [ + "", "", "", "" ], "type": "string" }, + "colorAlignment": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", + "description": "Optional. Color alignment configuration." + }, "conditioningFrames": { "description": "Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest.", "items": { @@ -46543,6 +49286,18 @@ }, "type": "array" }, + "customParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary.", + "type": "object" + }, + "exrColorSpaceOverride": { + "description": "Optional. Colorspace to be used for all EXR inputs.", + "type": "string" + }, "humanPose": { "$ref": "CloudAiLargeModelsVisionHumanPose", "description": "Human pose parameters for Pose Control" @@ -46556,6 +49311,14 @@ "format": "int32", "type": "integer" }, + "omniRewriter": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", + "description": "Optional. Omni Rewriter configuration." + }, + "originalRequestJson": { + "description": "The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable.", + "type": "string" + }, "promptInputs": { "$ref": "CloudAiLargeModelsVisionPromptInputs", "description": "Prompt chunks for \"ProModel\" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored." @@ -46564,6 +49327,18 @@ "description": "Optional tag for tracking the source of this request. Allowed values: \"colab\", \"comfyui\", \"curl\", \"flowresearch\", \"vertexstudio\". Unrecognized tags are recorded as \"unknown\" in metrics. Tags do not affect video generation behavior. Up to 16 characters, ASCII alphanumeric, hyphens, and underscores only.", "type": "string" }, + "schedulingConfig": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", + "description": "Optional. Scheduling configuration." + }, + "seamless": { + "$ref": "CloudAiLargeModelsVisionSeamless", + "description": "Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation." + }, + "spatialAlignment": { + "$ref": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", + "description": "Optional. Spatial alignment configuration." + }, "truncateInputVideo": { "description": "If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior.", "type": "boolean" @@ -46580,6 +49355,17 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig": { + "description": "Configuration for color alignment.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig", + "properties": { + "enable": { + "description": "Optional. If true, enable alignment.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame": { "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame", "properties": { @@ -46595,6 +49381,45 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig": { + "description": "Configuration for Omni Rewriter.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig", + "properties": { + "maxChunkDuration": { + "description": "Optional. Maximum duration of a chunk in seconds.", + "format": "float", + "type": "number" + }, + "rewriterInputFps": { + "description": "Optional. FPS used to generate gemini chunks for video inputs.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig": { + "description": "Configuration for spatial alignment.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig", + "properties": { + "enable": { + "description": "Optional. If true, enable alignment.", + "type": "boolean" + } + }, + "type": "object" + }, + "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig": { + "description": "Scheduling configuration for Veo Experimental.", + "id": "CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig", + "properties": { + "enableRetry": { + "description": "Optional. If true, enable retries on transient errors with default backoff.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionGenerateVideoRequestImage": { "description": "The image bytes or Cloud Storage URI to make the prediction on.", "id": "CloudAiLargeModelsVisionGenerateVideoRequestImage", @@ -46968,6 +49793,24 @@ }, "type": "object" }, + "CloudAiLargeModelsVisionSeamless": { + "id": "CloudAiLargeModelsVisionSeamless", + "properties": { + "loop": { + "description": "If true, the generated video will be loopable (seamless time looping).", + "type": "boolean" + }, + "tessellateHorizontal": { + "description": "If true, the generated video will be tessellatable as a horizontal tessellation.", + "type": "boolean" + }, + "tessellateVertical": { + "description": "If true, the generated video will be tessellatable as a vertical tessellation.", + "type": "boolean" + } + }, + "type": "object" + }, "CloudAiLargeModelsVisionSemanticFilterResponse": { "id": "CloudAiLargeModelsVisionSemanticFilterResponse", "properties": { @@ -47082,85 +49925,6 @@ }, "type": "object" }, - "GenaiField": { - "description": "Represents a single field in a struct.", - "id": "GenaiField", - "properties": { - "name": { - "type": "string" - }, - "value": { - "$ref": "GenaiValue" - } - }, - "type": "object" - }, - "GenaiListValue": { - "description": "`ListValue` is a wrapper around a repeated field of values.", - "id": "GenaiListValue", - "properties": { - "values": { - "description": "Repeated field of dynamically typed values.", - "items": { - "$ref": "GenaiValue" - }, - "type": "array" - } - }, - "type": "object" - }, - "GenaiStruct": { - "description": "`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.", - "id": "GenaiStruct", - "properties": { - "fields": { - "description": "Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.", - "items": { - "$ref": "GenaiField" - }, - "type": "array" - } - }, - "type": "object" - }, - "GenaiValue": { - "description": "`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.", - "id": "GenaiValue", - "properties": { - "boolValue": { - "description": "Represents a boolean value.", - "type": "boolean" - }, - "listValue": { - "$ref": "GenaiListValue", - "description": "Represents a repeated `Value`." - }, - "nullValue": { - "description": "Represents a null value.", - "enum": [ - "NULL_VALUE" - ], - "enumDescriptions": [ - "Null value." - ], - "type": "string" - }, - "numberValue": { - "description": "Represents a double value.", - "format": "double", - "type": "number" - }, - "stringValue": { - "description": "Represents a string value.", - "type": "string" - }, - "structValue": { - "$ref": "GenaiStruct", - "description": "Represents a structured value." - } - }, - "type": "object" - }, "GenaiVertexV1beta1AgentInteraction": { "description": "Interaction for generating the completion using agents.", "id": "GenaiVertexV1beta1AgentInteraction", @@ -47169,10 +49933,17 @@ "description": "The name of the `Agent` used for generating the completion.", "type": "string" }, - "deep_research_config": { + "antigravityConfig": { + "$ref": "GenaiVertexV1beta1AntigravityAgentConfig", + "description": "Antigravity agent configuration. This configuration is session-level settings that are passed to the agent runtime on a per-request basis." + }, + "codeMenderConfig": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfig" + }, + "deepResearchConfig": { "$ref": "GenaiVertexV1beta1DeepResearchAgentConfig" }, - "dynamic_config": { + "dynamicConfig": { "$ref": "GenaiVertexV1beta1DynamicAgentConfig" } }, @@ -47210,10 +49981,26 @@ }, "type": "object" }, + "GenaiVertexV1beta1AntigravityAgentConfig": { + "description": "Configuration for the Antigravity agent runtime. Provides server-side control over the agent's execution environment and tool configuration.", + "id": "GenaiVertexV1beta1AntigravityAgentConfig", + "properties": { + "maxTotalTokens": { + "description": "Max total tokens for the agent run.", + "format": "int64", + "type": "string" + }, + "model": { + "description": "The model to use for agent reasoning.", + "type": "string" + } + }, + "type": "object" + }, "GenaiVertexV1beta1ArgumentsDelta": { "id": "GenaiVertexV1beta1ArgumentsDelta", "properties": { - "partial_arguments": { + "arguments": { "type": "string" } }, @@ -47233,7 +50020,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "description": "The mime type of the audio.", "enum": [ "TYPE_UNSPECIFIED", @@ -47267,7 +50054,7 @@ ], "type": "string" }, - "sample_rate": { + "sampleRate": { "description": "The sample rate of the audio.", "format": "int32", "type": "integer" @@ -47291,7 +50078,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_WAV", @@ -47330,7 +50117,7 @@ "format": "int32", "type": "integer" }, - "sample_rate": { + "sampleRate": { "description": "The sample rate of the audio.", "format": "int32", "type": "integer" @@ -47345,7 +50132,7 @@ "description": "Configuration for audio output format.", "id": "GenaiVertexV1beta1AudioResponseFormat", "properties": { - "bit_rate": { + "bitRate": { "description": "Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", "format": "int32", "type": "integer" @@ -47355,16 +50142,16 @@ "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", - "URL" + "URI" ], "enumDescriptions": [ "Default value. This value is unused.", "Audio data is returned inline in the response.", - "Audio data is returned as a URL." + "Audio data is returned as a URI." ], "type": "string" }, - "mime_type": { + "mimeType": { "description": "The MIME type of the audio output.", "enum": [ "TYPE_UNSPECIFIED", @@ -47386,7 +50173,7 @@ ], "type": "string" }, - "sample_rate": { + "sampleRate": { "description": "Sample rate in Hz.", "format": "int32", "type": "integer" @@ -47401,6 +50188,7 @@ "type": "object" }, "GenaiVertexV1beta1CodeExecutionCallContent": { + "deprecated": true, "description": "Code execution content.", "id": "GenaiVertexV1beta1CodeExecutionCallContent", "properties": { @@ -47478,10 +50266,11 @@ "type": "object" }, "GenaiVertexV1beta1CodeExecutionResultContent": { + "deprecated": true, "description": "Code execution result content.", "id": "GenaiVertexV1beta1CodeExecutionResultContent", "properties": { - "is_error": { + "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" }, @@ -47495,7 +50284,7 @@ "GenaiVertexV1beta1CodeExecutionResultDelta": { "id": "GenaiVertexV1beta1CodeExecutionResultDelta", "properties": { - "is_error": { + "isError": { "type": "boolean" }, "result": { @@ -47508,7 +50297,7 @@ "description": "Code execution result step.", "id": "GenaiVertexV1beta1CodeExecutionResultStep", "properties": { - "is_error": { + "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" }, @@ -47519,23 +50308,170 @@ }, "type": "object" }, + "GenaiVertexV1beta1CodeMenderAgentConfig": { + "description": "Configuration for the CodeMender agent.", + "id": "GenaiVertexV1beta1CodeMenderAgentConfig", + "properties": { + "find_request": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest", + "description": "Parameters for finding vulnerabilities." + }, + "fix_request": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", + "description": "Parameters for fixing vulnerabilities." + }, + "model": { + "description": "The name of the model to use for the CodeMender agent. One CodeMender session will only use one model.", + "type": "string" + }, + "session_config": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig", + "description": "Optional session-specific configurations to override default agent behavior." + }, + "session_id": { + "description": "Parameter for grouping multiple interactions that belong to the same CodeMender session.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeMenderAgentConfigFileContent": { + "description": "Content of a single file in the codebase.", + "id": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent", + "properties": { + "content": { + "description": "The UTF-8 encoded text content of the file.", + "type": "string" + }, + "path": { + "description": "The relative path of the file from the project root.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest": { + "description": "Request parameters specific to FIND sessions, used for discovering vulnerabilities in a codebase.", + "id": "GenaiVertexV1beta1CodeMenderAgentConfigFindRequest", + "properties": { + "description": { + "description": "Additional context or custom instructions provided by the user to guide the vulnerability analysis.", + "type": "string" + }, + "finding_id": { + "description": "The identifier of a specific finding to verify. This is primarily used in VERIFY mode to focus the agent's execution-based validation on a single vulnerability.", + "type": "string" + }, + "mode": { + "description": "The mode of the find session.", + "enum": [ + "MODE_UNSPECIFIED", + "MODE_SCAN", + "MODE_VERIFY" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Fast scan using only the initial classifier.", + "Performs classification followed by detailed investigation." + ], + "type": "string" + }, + "source_files": { + "description": "A list of source files to provide as context for the scan.", + "items": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest": { + "description": "Request parameters specific to FIX sessions, used for generating and validating security patches.", + "id": "GenaiVertexV1beta1CodeMenderAgentConfigFixRequest", + "properties": { + "description": { + "description": "Additional context or custom instructions provided by the user to guide the patch generation process.", + "type": "string" + }, + "finding_id": { + "description": "The identifier of the specific security finding to be remediated. This ID maps to a previously discovered vulnerability.", + "type": "string" + }, + "source_files": { + "description": "A list of source files providing context for the remediation. These files are typically the ones containing the identified vulnerability.", + "items": { + "$ref": "GenaiVertexV1beta1CodeMenderAgentConfigFileContent" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig": { + "description": "The configuration of CodeMender sessions.", + "id": "GenaiVertexV1beta1CodeMenderAgentConfigSessionConfig", + "properties": { + "max_rounds": { + "description": "The maximum number of interaction rounds the agent is allowed to perform before reaching a timeout.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GenaiVertexV1beta1ComputerUse": { "description": "A tool that can be used by the model to interact with the computer.", "id": "GenaiVertexV1beta1ComputerUse", "properties": { + "disabledSafetyPolicies": { + "description": "Optional. Disabled safety policies for computer use.", + "items": { + "enum": [ + "SAFETY_POLICY_UNSPECIFIED", + "FINANCIAL_TRANSACTIONS", + "SENSITIVE_DATA_MODIFICATION", + "COMMUNICATION_TOOL", + "ACCOUNT_CREATION", + "DATA_MODIFICATION", + "USER_CONSENT_MANAGEMENT", + "LEGAL_TERMS_AND_AGREEMENTS" + ], + "enumDescriptions": [ + "Unspecified safety policy.", + "Safety policy for financial transactions.", + "Safety policy for sensitive data modification.", + "Safety policy for communication tools (e.g. Gmail, Chat, Meet).", + "Safety policy for account creation.", + "Safety policy for data modification.", + "Safety policy for user consent management.", + "Safety policy for legal terms and agreements." + ], + "type": "string" + }, + "type": "array" + }, + "enablePromptInjectionDetection": { + "description": "Whether enable the prompt injection detection check on computer-use request.", + "type": "boolean" + }, "environment": { "description": "The environment being operated.", "enum": [ "ENVIRONMENT_UNSPECIFIED", - "BROWSER" + "BROWSER", + "MOBILE", + "DESKTOP" ], "enumDescriptions": [ "Defaults to browser.", - "Operates in a web browser." + "Operates in a web browser.", + "Operates in a mobile environment.", + "Operates in a desktop environment." ], "type": "string" }, - "excluded_predefined_functions": { + "excludedPredefinedFunctions": { "description": "The list of predefined functions that are excluded from the model call.", "items": { "type": "string" @@ -47693,11 +50629,15 @@ "description": "Configuration for the Deep Research agent.", "id": "GenaiVertexV1beta1DeepResearchAgentConfig", "properties": { - "collaborative_planning": { + "collaborativePlanning": { "description": "Enables human-in-the-loop planning for the Deep Research agent. If set to true, the Deep Research agent will provide a research plan in its response. The agent will then proceed only if the user confirms the plan in the next turn.", "type": "boolean" }, - "thinking_summaries": { + "enableBigqueryTool": { + "description": "Enables bigquery tool for the Deep Research agent.", + "type": "boolean" + }, + "thinkingSummaries": { "description": "Whether to include thought summaries in the response.", "enum": [ "THINKING_SUMMARIES_UNSPECIFIED", @@ -47728,6 +50668,12 @@ }, "type": "object" }, + "GenaiVertexV1beta1DeleteInteractionResponse": { + "description": "Response for InteractionService.DeleteInteraction.", + "id": "GenaiVertexV1beta1DeleteInteractionResponse", + "properties": {}, + "type": "object" + }, "GenaiVertexV1beta1DocumentContent": { "description": "A document content block.", "id": "GenaiVertexV1beta1DocumentContent", @@ -47737,15 +50683,17 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "description": "The mime type of the document.", "enum": [ "TYPE_UNSPECIFIED", - "TYPE_PDF" + "TYPE_PDF", + "TYPE_CSV" ], "enumDescriptions": [ "", - "PDF document format" + "PDF document format", + "CSV document format" ], "type": "string" }, @@ -47763,14 +50711,16 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "enum": [ "TYPE_UNSPECIFIED", - "TYPE_PDF" + "TYPE_PDF", + "TYPE_CSV" ], "enumDescriptions": [ "", - "PDF document format" + "PDF document format", + "CSV document format" ], "type": "string" }, @@ -47785,12 +50735,117 @@ "id": "GenaiVertexV1beta1DynamicAgentConfig", "properties": { "config": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "For agents that are not supported statically in the API definition." } }, "type": "object" }, + "GenaiVertexV1beta1EnvironmentConfig": { + "description": "Configuration for a custom environment.", + "id": "GenaiVertexV1beta1EnvironmentConfig", + "properties": { + "environmentId": { + "description": "Optional. The environment ID for the interaction. If specified, the request will update the existing environment instead of creating a new one.", + "type": "string" + }, + "networkAllowlist": { + "$ref": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", + "description": "Allow only specific domains." + }, + "networkMode": { + "description": "Network egress mode.", + "enum": [ + "NETWORK_MODE_UNSPECIFIED", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. Unused.", + "All network egress is blocked." + ], + "type": "string" + }, + "sources": { + "items": { + "$ref": "GenaiVertexV1beta1EnvironmentConfigSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1EnvironmentConfigEgressRule": { + "description": "A network egress rule that controls which external domains the environment is allowed to reach. Each rule identifies a target domain and, optionally, a set of HTTP headers to inject into every matching outbound request.", + "id": "GenaiVertexV1beta1EnvironmentConfigEgressRule", + "properties": { + "domain": { + "description": "The domain pattern to match for this rule. Use an exact hostname (e.g., `github.com`), a wildcard prefix (e.g., `*.googleapis.com`), or `*` to match all domains.", + "type": "string" + }, + "transform": { + "additionalProperties": { + "type": "string" + }, + "description": "Headers to inject into requests matching this rule. Key: header name (e.g., \"Authorization\"). Value: header value (e.g., \"Bearer your-token\").", + "type": "object" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist": { + "description": "Network egress configuration for the environment.", + "id": "GenaiVertexV1beta1EnvironmentConfigEnvironmentNetworkEgressAllowlist", + "properties": { + "allowlist": { + "description": "List of allowed domains and their configurations.", + "items": { + "$ref": "GenaiVertexV1beta1EnvironmentConfigEgressRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1EnvironmentConfigSource": { + "description": "A source to be mounted into the environment.", + "id": "GenaiVertexV1beta1EnvironmentConfigSource", + "properties": { + "content": { + "description": "The inline content if `type` is `INLINE`.", + "type": "string" + }, + "encoding": { + "description": "Optional encoding for inline content (e.g. `base64`).", + "type": "string" + }, + "source": { + "description": "The source of the environment. For GCS, this is the GCS path. For GitHub, this is the GitHub path.", + "type": "string" + }, + "target": { + "description": "Where the source should appear in the environment.", + "type": "string" + }, + "type": { + "enum": [ + "TYPE_UNSPECIFIED", + "GCS", + "INLINE", + "REPOSITORY", + "SKILL_REGISTRY" + ], + "enumDescriptions": [ + "", + "A GCS bucket.", + "Inline content.", + "A generic repository. The protocol prefix in the source URL identifies the provider (e.g., github://, gcs://).", + "A skill resource from the Skill Registry Service. Skill: projects/{project}/locations/{location}/skills/{skill} SkillRevision: projects/{project}/locations/{location}/skills/{skill}/revisions/{revision} Support mounting all skills under a project: projects/{project}/locations/{location}/skills." + ], + "type": "string" + } + }, + "type": "object" + }, "GenaiVertexV1beta1Error": { "description": "Error message from an interaction.", "id": "GenaiVertexV1beta1Error", @@ -47815,27 +50870,59 @@ }, "type": "object" }, + "GenaiVertexV1beta1ExaAISearchConfig": { + "description": "Used to specify configuration for ExaAISearch.", + "id": "GenaiVertexV1beta1ExaAISearchConfig", + "properties": { + "api_key": { + "description": "Required. The API key for ExaAiSearch.", + "type": "string" + }, + "custom_config": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", + "type": "object" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Field": { + "description": "Represents a single field in a struct.", + "id": "GenaiVertexV1beta1Field", + "properties": { + "name": { + "type": "string" + }, + "value": { + "$ref": "GenaiVertexV1beta1Value" + } + }, + "type": "object" + }, "GenaiVertexV1beta1FileCitation": { "description": "A file citation annotation.", "id": "GenaiVertexV1beta1FileCitation", "properties": { - "custom_metadata": { - "$ref": "GenaiStruct", + "customMetadata": { + "$ref": "GenaiVertexV1beta1Struct", "description": "User provided metadata about the retrieved context." }, - "document_uri": { + "documentUri": { "description": "The URI of the file.", "type": "string" }, - "file_name": { + "fileName": { "description": "The name of the file.", "type": "string" }, - "media_id": { + "mediaId": { "description": "Media ID in-case of image citations, if applicable.", "type": "string" }, - "page_number": { + "pageNumber": { "description": "Page number of the cited document, if applicable.", "format": "int32", "type": "integer" @@ -47851,18 +50938,18 @@ "description": "A tool that can be used by the model to search files.", "id": "GenaiVertexV1beta1FileSearch", "properties": { - "file_search_store_names": { + "fileSearchStoreNames": { "description": "The file search store names to search.", "items": { "type": "string" }, "type": "array" }, - "metadata_filter": { + "metadataFilter": { "description": "Metadata filter to apply to the semantic retrieval documents and chunks.", "type": "string" }, - "top_k": { + "topK": { "description": "The number of semantic retrieval chunks to retrieve.", "format": "int32", "type": "integer" @@ -47871,6 +50958,7 @@ "type": "object" }, "GenaiVertexV1beta1FileSearchCallContent": { + "deprecated": true, "description": "File Search content.", "id": "GenaiVertexV1beta1FileSearchCallContent", "properties": {}, @@ -47888,6 +50976,7 @@ "type": "object" }, "GenaiVertexV1beta1FileSearchResultContent": { + "deprecated": true, "description": "File Search result content.", "id": "GenaiVertexV1beta1FileSearchResultContent", "properties": { @@ -47938,18 +51027,19 @@ "type": "string" }, "parameters": { - "$ref": "GenaiValue", + "$ref": "GenaiVertexV1beta1Value", "description": "The JSON Schema for the function's parameters." } }, "type": "object" }, "GenaiVertexV1beta1FunctionCallContent": { + "deprecated": true, "description": "A function tool call content block.", "id": "GenaiVertexV1beta1FunctionCallContent", "properties": { "arguments": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The arguments to pass to the function." }, "name": { @@ -47963,7 +51053,7 @@ "id": "GenaiVertexV1beta1FunctionCallDelta", "properties": { "arguments": { - "$ref": "GenaiStruct" + "$ref": "GenaiVertexV1beta1Struct" }, "name": { "type": "string" @@ -47976,7 +51066,7 @@ "id": "GenaiVertexV1beta1FunctionCallStep", "properties": { "arguments": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The arguments to pass to the function." }, "name": { @@ -47987,13 +51077,14 @@ "type": "object" }, "GenaiVertexV1beta1FunctionResultContent": { + "deprecated": true, "description": "A function tool result content block.", "id": "GenaiVertexV1beta1FunctionResultContent", "properties": { "contentList": { "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" }, - "is_error": { + "isError": { "description": "Whether the tool call resulted in an error.", "type": "boolean" }, @@ -48005,7 +51096,7 @@ "type": "string" }, "structResult": { - "$ref": "GenaiStruct" + "$ref": "GenaiVertexV1beta1Struct" } }, "type": "object" @@ -48013,20 +51104,14 @@ "GenaiVertexV1beta1FunctionResultDelta": { "id": "GenaiVertexV1beta1FunctionResultDelta", "properties": { - "contentList": { - "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" - }, - "is_error": { + "isError": { "type": "boolean" }, "name": { "type": "string" }, - "stringResult": { - "type": "string" - }, - "structResult": { - "$ref": "GenaiStruct" + "result": { + "$ref": "GenaiVertexV1beta1Value" } }, "type": "object" @@ -48035,10 +51120,7 @@ "description": "Result of a function tool call.", "id": "GenaiVertexV1beta1FunctionResultStep", "properties": { - "contentList": { - "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" - }, - "is_error": { + "isError": { "description": "Whether the tool call resulted in an error.", "type": "boolean" }, @@ -48046,11 +51128,9 @@ "description": "The name of the tool that was called.", "type": "string" }, - "stringResult": { - "type": "string" - }, - "structResult": { - "$ref": "GenaiStruct" + "result": { + "$ref": "GenaiVertexV1beta1Value", + "description": "Required. The result of the tool call." } }, "type": "object" @@ -48083,11 +51163,12 @@ "description": "Configuration parameters for model interactions.", "id": "GenaiVertexV1beta1GenerationConfig", "properties": { - "image_config": { + "imageConfig": { "$ref": "GenaiVertexV1beta1ImageConfig", + "deprecated": true, "description": "Configuration for image interaction." }, - "max_output_tokens": { + "maxOutputTokens": { "description": "The maximum number of tokens to include in the response.", "format": "int32", "type": "integer" @@ -48097,14 +51178,14 @@ "format": "int32", "type": "integer" }, - "speech_config": { + "speechConfig": { "description": "Configuration for speech interaction.", "items": { "$ref": "GenaiVertexV1beta1SpeechConfig" }, "type": "array" }, - "stop_sequences": { + "stopSequences": { "description": "A list of character sequences that will stop output interaction.", "items": { "type": "string" @@ -48116,7 +51197,7 @@ "format": "float", "type": "number" }, - "thinking_level": { + "thinkingLevel": { "description": "The level of thought tokens that the model should generate.", "enum": [ "THINKING_LEVEL_UNSPECIFIED", @@ -48134,7 +51215,7 @@ ], "type": "string" }, - "thinking_summaries": { + "thinkingSummaries": { "description": "Whether to include thought summaries in the response.", "enum": [ "THINKING_SUMMARIES_UNSPECIFIED", @@ -48170,10 +51251,18 @@ ], "type": "string" }, - "top_p": { + "topP": { "description": "The maximum cumulative probability of tokens to consider when sampling.", "format": "float", "type": "number" + }, + "transcriptionConfig": { + "$ref": "GenaiVertexV1beta1TranscriptionConfig", + "description": "Optional. Configuration for speech recognition (transcription). If present, ASR is enabled." + }, + "videoConfig": { + "$ref": "GenaiVertexV1beta1VideoConfig", + "description": "Configuration for video generation." } }, "type": "object" @@ -48182,7 +51271,7 @@ "description": "A tool that can be used by the model to call Google Maps.", "id": "GenaiVertexV1beta1GoogleMaps", "properties": { - "enable_widget": { + "enableWidget": { "description": "Whether to return a widget context token in the tool call result of the response.", "type": "boolean" }, @@ -48200,6 +51289,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleMapsCallContent": { + "deprecated": true, "description": "Google Maps content.", "id": "GenaiVertexV1beta1GoogleMapsCallContent", "properties": { @@ -48260,6 +51350,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleMapsResultContent": { + "deprecated": true, "description": "Google Maps result content.", "id": "GenaiVertexV1beta1GoogleMapsResultContent", "properties": { @@ -48284,7 +51375,7 @@ }, "type": "array" }, - "widget_context_token": { + "widgetContextToken": { "description": "Resource name of the Google Maps widget context token.", "type": "string" } @@ -48298,11 +51389,11 @@ "description": "Title of the place.", "type": "string" }, - "place_id": { + "placeId": { "description": "The ID of the place, in `places/{place_id}` format.", "type": "string" }, - "review_snippets": { + "reviewSnippets": { "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" @@ -48352,7 +51443,7 @@ }, "type": "array" }, - "widget_context_token": { + "widgetContextToken": { "type": "string" } }, @@ -48364,10 +51455,10 @@ "name": { "type": "string" }, - "place_id": { + "placeId": { "type": "string" }, - "review_snippets": { + "reviewSnippets": { "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" }, @@ -48383,7 +51474,7 @@ "description": "A tool that can be used by the model to search Google.", "id": "GenaiVertexV1beta1GoogleSearch", "properties": { - "search_types": { + "searchTypes": { "description": "The types of search grounding to enable.", "items": { "enum": [ @@ -48406,6 +51497,7 @@ "type": "object" }, "GenaiVertexV1beta1GoogleSearchCallContent": { + "deprecated": true, "description": "Google Search content.", "id": "GenaiVertexV1beta1GoogleSearchCallContent", "properties": { @@ -48413,7 +51505,7 @@ "$ref": "GenaiVertexV1beta1GoogleSearchCallContentGoogleSearchCallArguments", "description": "Required. The arguments to pass to Google Search." }, - "search_type": { + "searchType": { "description": "The type of search grounding enabled.", "enum": [ "SEARCH_TYPE_UNSPECIFIED", @@ -48463,7 +51555,7 @@ "$ref": "GenaiVertexV1beta1GoogleSearchCallStepGoogleSearchCallStepArguments", "description": "Required. The arguments to pass to Google Search." }, - "search_type": { + "searchType": { "description": "The type of search grounding enabled.", "enum": [ "SEARCH_TYPE_UNSPECIFIED", @@ -48497,10 +51589,11 @@ "type": "object" }, "GenaiVertexV1beta1GoogleSearchResultContent": { + "deprecated": true, "description": "Google Search result content.", "id": "GenaiVertexV1beta1GoogleSearchResultContent", "properties": { - "is_error": { + "isError": { "description": "Whether the Google Search resulted in an error.", "type": "boolean" }, @@ -48518,7 +51611,7 @@ "description": "The result of the Google Search.", "id": "GenaiVertexV1beta1GoogleSearchResultContentGoogleSearchResult", "properties": { - "search_suggestions": { + "searchSuggestions": { "description": "Web content snippet that can be embedded in a web page or an app webview.", "type": "string" } @@ -48528,7 +51621,7 @@ "GenaiVertexV1beta1GoogleSearchResultDelta": { "id": "GenaiVertexV1beta1GoogleSearchResultDelta", "properties": { - "is_error": { + "isError": { "type": "boolean" }, "result": { @@ -48544,7 +51637,7 @@ "description": "Google Search result step.", "id": "GenaiVertexV1beta1GoogleSearchResultStep", "properties": { - "is_error": { + "isError": { "description": "Whether the Google Search resulted in an error.", "type": "boolean" }, @@ -48562,7 +51655,7 @@ "description": "The result of the Google Search.", "id": "GenaiVertexV1beta1GoogleSearchResultStepGoogleSearchResultItem", "properties": { - "search_suggestions": { + "searchSuggestions": { "description": "Web content snippet that can be embedded in a web page or an app webview.", "type": "string" } @@ -48573,11 +51666,11 @@ "description": "The configuration for image interaction.", "id": "GenaiVertexV1beta1ImageConfig", "properties": { - "aspect_ratio": { + "aspectRatio": { "description": "The aspect ratio of the image to generate. Supported aspect ratios: 1:1, 2:3, 3:2, 3:4, 4:3, 9:16, 16:9, 21:9. If not specified, the model will choose a default aspect ratio based on any reference images provided.", "type": "string" }, - "image_size": { + "imageSize": { "description": "Specifies the size of generated images. Supported values are `1K`, `2K`, `4K`. If not specified, the model will use default value `1K`.", "type": "string" } @@ -48593,7 +51686,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "description": "The mime type of the image.", "enum": [ "TYPE_UNSPECIFIED", @@ -48651,7 +51744,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_PNG", @@ -48704,7 +51797,7 @@ "description": "Configuration for image output format.", "id": "GenaiVertexV1beta1ImageResponseFormat", "properties": { - "aspect_ratio": { + "aspectRatio": { "description": "The aspect ratio for the image output.", "enum": [ "ASPECT_RATIO_UNSPECIFIED", @@ -48747,16 +51840,16 @@ "enum": [ "DELIVERY_UNSPECIFIED", "INLINE", - "URL" + "URI" ], "enumDescriptions": [ "Default value. This value is unused.", "Image data is returned inline in the response.", - "Image data is returned as a URL." + "Image data is returned as a URI." ], "type": "string" }, - "image_size": { + "imageSize": { "description": "The size of the image output.", "enum": [ "IMAGE_SIZE_UNSPECIFIED", @@ -48774,7 +51867,7 @@ ], "type": "string" }, - "mime_type": { + "mimeType": { "description": "The MIME type of the image output.", "enum": [ "TYPE_UNSPECIFIED", @@ -48811,11 +51904,31 @@ "readOnly": true, "type": "string" }, + "envId": { + "description": "The environment ID for the interaction. Can be 'remote' for default environment.", + "type": "string" + }, + "environmentId": { + "description": "Output only. The environment ID for the interaction. Only populated if environment config is set in the request.", + "readOnly": true, + "type": "string" + }, "id": { "description": "Required. Output only. A unique identifier for the interaction completion.", "readOnly": true, "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" + }, + "localEnvironment": { + "$ref": "GenaiVertexV1beta1LocalEnvironmentConfig", + "description": "The agent's environment lives on the client connection: its built-in environment operations (filesystem ops and running commands) are yielded to the client to execute, instead of running in a server-managed sandbox. Mutually exclusive with `remote_environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.)" + }, "modelInteraction": { "$ref": "GenaiVertexV1beta1ModelInteraction", "description": "Interaction for generating the completion using models." @@ -48829,26 +51942,31 @@ "readOnly": true, "type": "array" }, - "previous_interaction_id": { + "previousInteractionId": { "description": "The ID of the previous interaction, if any.", "type": "string" }, + "remoteEnvironment": { + "$ref": "GenaiVertexV1beta1EnvironmentConfig" + }, + "responseFormat": { + "$ref": "GenaiVertexV1beta1Value", + "deprecated": true, + "description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field." + }, "responseFormatList": { "$ref": "GenaiVertexV1beta1ResponseFormatList" }, "responseFormatSingleton": { "$ref": "GenaiVertexV1beta1ResponseFormat" }, - "response_format": { - "$ref": "GenaiValue", + "responseMimeType": { "deprecated": true, - "description": "Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field." - }, - "response_mime_type": { "description": "The mime type of the response. This is required if response_format is set.", "type": "string" }, - "response_modalities": { + "responseModalities": { + "deprecated": true, "description": "The requested modalities of the response (TEXT, IMAGE, AUDIO).", "items": { "enum": [ @@ -48877,6 +51995,13 @@ "readOnly": true, "type": "string" }, + "safety_settings": { + "description": "Safety settings for the interaction.", + "items": { + "$ref": "GenaiVertexV1beta1SafetySetting" + }, + "type": "array" + }, "status": { "description": "Required. Output only. The status of the interaction.", "enum": [ @@ -48886,7 +52011,9 @@ "COMPLETED", "FAILED", "CANCELLED", - "INCOMPLETE" + "INCOMPLETE", + "BUDGET_EXCEEDED", + "QUEUED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -48895,7 +52022,9 @@ "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", - "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." + "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", + "The interaction was halted because the token budget was exceeded.", + "The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ], "readOnly": true, "type": "string" @@ -48905,7 +52034,7 @@ "description": "Input only. The steps for the interaction." }, "steps": { - "description": "Output only. The steps that make up the interaction.", + "description": "Required. Output only. The steps that make up the interaction.", "items": { "$ref": "GenaiVertexV1beta1Step" }, @@ -48916,7 +52045,7 @@ "description": "A string input for the interaction, it will be processed as a single text input.", "type": "string" }, - "system_instruction": { + "systemInstruction": { "description": "System instruction for the interaction.", "type": "string" }, @@ -48988,7 +52117,7 @@ "GenaiVertexV1beta1InteractionStatusUpdate": { "id": "GenaiVertexV1beta1InteractionStatusUpdate", "properties": { - "interaction_id": { + "interactionId": { "type": "string" }, "status": { @@ -48999,7 +52128,9 @@ "COMPLETED", "FAILED", "CANCELLED", - "INCOMPLETE" + "INCOMPLETE", + "BUDGET_EXCEEDED", + "QUEUED" ], "enumDescriptions": [ "Default value. This value is unused.", @@ -49008,7 +52139,9 @@ "The interaction is completed.", "The interaction failed.", "The interaction was cancelled.", - "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens)." + "The interaction is completed, but contains incomplete results (e.g. hitting max_tokens).", + "The interaction was halted because the token budget was exceeded.", + "The interaction is queued, waiting for processing (e.g. waiting for off-peak capacity)." ], "type": "string" } @@ -49020,57 +52153,61 @@ "properties": { "contentDelta": { "$ref": "GenaiVertexV1beta1ContentDelta", - "description": "The content block delta data, used for content.delta events." + "description": "The content block delta data, used for content.delta events. Legacy content-based streaming event, used when steps are disabled." }, "contentStart": { "$ref": "GenaiVertexV1beta1ContentStart", - "description": "The content block start data, used for content.start events." + "description": "The content block start data, used for content.start events. Legacy content-based streaming event, used when steps are disabled." }, "contentStop": { "$ref": "GenaiVertexV1beta1ContentStop", - "description": "The content block stop data, used for content.stop events." + "description": "The content block stop data, used for content.stop events. Legacy content-based streaming event, used when steps are disabled." }, "errorEvent": { "$ref": "GenaiVertexV1beta1ErrorEvent", "description": "The error event data, used for error events." }, - "event_id": { + "eventId": { "description": "The event_id token to be used to resume the interaction stream, from this event.", "type": "string" }, "interactionCompleteEvent": { "$ref": "GenaiVertexV1beta1InteractionCompleteEvent", "deprecated": true, - "description": "The interaction data, used for interaction.complete events." + "description": "The interaction data, used for interaction.complete events. Legacy event, used when steps are disabled." }, "interactionCompletedEvent": { "$ref": "GenaiVertexV1beta1InteractionCompletedSseEvent", - "description": "The interaction data, used for interaction.completed events." + "description": "The interaction data, used for interaction.completed events. Used when steps are enabled." }, "interactionCreatedEvent": { "$ref": "GenaiVertexV1beta1InteractionCreatedSseEvent", - "description": "The interaction data, used for interaction.created events." + "description": "The interaction data, used for interaction.created events. Used when steps are enabled." }, "interactionStartEvent": { "$ref": "GenaiVertexV1beta1InteractionStartEvent", "deprecated": true, - "description": "The interaction data, used for interaction.start events." + "description": "The interaction data, used for interaction.start events. Legacy event, used when steps are disabled." }, "interactionStatusUpdate": { "$ref": "GenaiVertexV1beta1InteractionStatusUpdate", "description": "The interaction status data, used for interaction.status_update events." }, + "metadata": { + "$ref": "GenaiVertexV1beta1StreamMetadata", + "description": "Optional metadata accompanying ANY streamed event." + }, "stepDelta": { "$ref": "GenaiVertexV1beta1StepDelta", - "description": "The step delta data, used for step.delta events." + "description": "The step delta data, used for step.delta events. Step-based streaming event, used when steps are enabled." }, "stepStart": { "$ref": "GenaiVertexV1beta1StepStart", - "description": "The step start data, used for step.start events." + "description": "The step start data, used for step.start events. Step-based streaming event, used when steps are enabled." }, "stepStop": { "$ref": "GenaiVertexV1beta1StepStop", - "description": "The step stop data, used for step.stop events." + "description": "The step stop data, used for step.stop events. Step-based streaming event, used when steps are enabled." } }, "type": "object" @@ -49079,67 +52216,67 @@ "description": "Statistics on the interaction request's token usage.", "id": "GenaiVertexV1beta1InteractionUsage", "properties": { - "cached_tokens_by_modality": { + "cachedTokensByModality": { "description": "A breakdown of cached token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, - "grounding_tool_count": { + "groundingToolCount": { "description": "Grounding tool count.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageGroundingToolCount" }, "type": "array" }, - "input_tokens_by_modality": { + "inputTokensByModality": { "description": "A breakdown of input token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, - "output_tokens_by_modality": { + "outputTokensByModality": { "description": "A breakdown of output token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, - "tool_use_tokens_by_modality": { + "toolUseTokensByModality": { "description": "A breakdown of tool-use token usage by modality.", "items": { "$ref": "GenaiVertexV1beta1InteractionUsageModalityTokens" }, "type": "array" }, - "total_cached_tokens": { + "totalCachedTokens": { "description": "Number of tokens in the cached part of the prompt (the cached content).", "format": "int32", "type": "integer" }, - "total_input_tokens": { + "totalInputTokens": { "description": "Number of tokens in the prompt (context).", "format": "int32", "type": "integer" }, - "total_output_tokens": { + "totalOutputTokens": { "description": "Total number of tokens across all the generated responses.", "format": "int32", "type": "integer" }, - "total_thought_tokens": { + "totalThoughtTokens": { "description": "Number of tokens of thoughts for thinking models.", "format": "int32", "type": "integer" }, - "total_tokens": { + "totalTokens": { "description": "Total token count for the interaction request (prompt + responses + other internal tokens).", "format": "int32", "type": "integer" }, - "total_tool_use_tokens": { + "totalToolUseTokens": { "description": "Number of tokens present in tool-use prompt(s).", "format": "int32", "type": "integer" @@ -49207,11 +52344,31 @@ }, "type": "object" }, + "GenaiVertexV1beta1ListValue": { + "description": "`ListValue` is a wrapper around a repeated field of values.", + "id": "GenaiVertexV1beta1ListValue", + "properties": { + "values": { + "description": "Repeated field of dynamically typed values.", + "items": { + "$ref": "GenaiVertexV1beta1Value" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1LocalEnvironmentConfig": { + "description": "Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field.", + "id": "GenaiVertexV1beta1LocalEnvironmentConfig", + "properties": {}, + "type": "object" + }, "GenaiVertexV1beta1McpServer": { "description": "A MCPServer is a server that can be called by the model to perform actions.", "id": "GenaiVertexV1beta1McpServer", "properties": { - "allowed_tools": { + "allowedTools": { "description": "The allowed tools.", "items": { "$ref": "GenaiVertexV1beta1AllowedTools" @@ -49241,14 +52398,14 @@ "id": "GenaiVertexV1beta1McpServerToolCallContent", "properties": { "arguments": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The JSON object of arguments for the function." }, "name": { "description": "Required. The name of the tool which was called.", "type": "string" }, - "server_name": { + "serverName": { "description": "Required. The name of the used MCP server.", "type": "string" } @@ -49259,12 +52416,12 @@ "id": "GenaiVertexV1beta1McpServerToolCallDelta", "properties": { "arguments": { - "$ref": "GenaiStruct" + "$ref": "GenaiVertexV1beta1Struct" }, "name": { "type": "string" }, - "server_name": { + "serverName": { "type": "string" } }, @@ -49275,14 +52432,14 @@ "id": "GenaiVertexV1beta1McpServerToolCallStep", "properties": { "arguments": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "Required. The JSON object of arguments for the function." }, "name": { "description": "Required. The name of the tool which was called.", "type": "string" }, - "server_name": { + "serverName": { "description": "Required. The name of the used MCP server.", "type": "string" } @@ -49300,7 +52457,7 @@ "description": "Name of the tool which is called for this specific tool call.", "type": "string" }, - "server_name": { + "serverName": { "description": "The name of the used MCP server.", "type": "string" }, @@ -49308,7 +52465,7 @@ "type": "string" }, "structResult": { - "$ref": "GenaiStruct" + "$ref": "GenaiVertexV1beta1Struct" } }, "type": "object" @@ -49316,20 +52473,14 @@ "GenaiVertexV1beta1McpServerToolResultDelta": { "id": "GenaiVertexV1beta1McpServerToolResultDelta", "properties": { - "contentList": { - "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" - }, "name": { "type": "string" }, - "server_name": { - "type": "string" + "result": { + "$ref": "GenaiVertexV1beta1Value" }, - "stringResult": { + "serverName": { "type": "string" - }, - "structResult": { - "$ref": "GenaiStruct" } }, "type": "object" @@ -49338,22 +52489,17 @@ "description": "MCPServer tool result step.", "id": "GenaiVertexV1beta1McpServerToolResultStep", "properties": { - "contentList": { - "$ref": "GenaiVertexV1beta1FunctionResultSubcontentList" - }, "name": { "description": "Name of the tool which is called for this specific tool call.", "type": "string" }, - "server_name": { - "description": "The name of the used MCP server.", - "type": "string" + "result": { + "$ref": "GenaiVertexV1beta1Value", + "description": "Required. The output from the MCP server call. Can be simple text or rich content." }, - "stringResult": { + "serverName": { + "description": "The name of the used MCP server.", "type": "string" - }, - "structResult": { - "$ref": "GenaiStruct" } }, "type": "object" @@ -49362,7 +52508,7 @@ "description": "Interaction for generating the completion using models.", "id": "GenaiVertexV1beta1ModelInteraction", "properties": { - "generation_config": { + "generationConfig": { "$ref": "GenaiVertexV1beta1GenerationConfig", "description": "Input only. Configuration parameters for the model interaction." }, @@ -49382,6 +52528,29 @@ "$ref": "GenaiVertexV1beta1Content" }, "type": "array" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ParallelAISearchConfig": { + "description": "Used to specify configuration for ParallelAISearch.", + "id": "GenaiVertexV1beta1ParallelAISearchConfig", + "properties": { + "api_key": { + "description": "Optional. The API key for ParallelAiSearch.", + "type": "string" + }, + "custom_config": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Custom configs for ParallelAiSearch.", + "type": "object" } }, "type": "object" @@ -49394,11 +52563,11 @@ "description": "Title of the place.", "type": "string" }, - "place_id": { + "placeId": { "description": "The ID of the place, in `places/{place_id}` format.", "type": "string" }, - "review_snippets": { + "reviewSnippets": { "description": "Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.", "items": { "$ref": "GenaiVertexV1beta1ReviewSnippet" @@ -49412,6 +52581,133 @@ }, "type": "object" }, + "GenaiVertexV1beta1RagStoreConfig": { + "description": "Use to specify configuration for RAG Store.", + "id": "GenaiVertexV1beta1RagStoreConfig", + "properties": { + "rag_resources": { + "description": "Optional. The representation of the rag source.", + "items": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagResource" + }, + "type": "array" + }, + "rag_retrieval_config": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig", + "description": "Optional. The retrieval config for the Rag query." + }, + "similarity_top_k": { + "deprecated": true, + "description": "Optional. Number of top k results to return from the selected corpora.", + "format": "int32", + "type": "integer" + }, + "vector_distance_threshold": { + "deprecated": true, + "description": "Optional. Only return results with vector distance smaller than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagResource": { + "description": "The definition of the Rag resource.", + "id": "GenaiVertexV1beta1RagStoreConfigRagResource", + "properties": { + "rag_corpus": { + "description": "Optional. RagCorpora resource name.", + "type": "string" + }, + "rag_file_ids": { + "description": "Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig": { + "description": "Specifies the context retrieval config.", + "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfig", + "properties": { + "filter": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter", + "description": "Optional. Config for filters." + }, + "hybrid_search": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch", + "description": "Optional. Config for Hybrid Search." + }, + "ranking": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking", + "description": "Optional. Config for ranking and reranking." + }, + "top_k": { + "description": "Optional. The number of contexts to retrieve.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter": { + "description": "Config for filters.", + "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigFilter", + "properties": { + "metadata_filter": { + "description": "Optional. String for metadata filtering.", + "type": "string" + }, + "vector_distance_threshold": { + "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", + "format": "double", + "type": "number" + }, + "vector_similarity_threshold": { + "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch": { + "description": "Config for Hybrid Search.", + "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigHybridSearch", + "properties": { + "alpha": { + "description": "Optional. Alpha value controls the weight between dense and sparse vector search results.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking": { + "description": "Config for ranking and reranking.", + "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRanking", + "properties": { + "rank_service": { + "$ref": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService", + "description": "Optional. Config for Rank Service." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService": { + "description": "Config for Rank Service.", + "id": "GenaiVertexV1beta1RagStoreConfigRagRetrievalConfigRankingRankService", + "properties": { + "model_name": { + "description": "Optional. The model name of the rank service.", + "type": "string" + } + }, + "type": "object" + }, "GenaiVertexV1beta1ResponseFormat": { "id": "GenaiVertexV1beta1ResponseFormat", "properties": { @@ -49422,7 +52718,7 @@ "$ref": "GenaiVertexV1beta1ImageResponseFormat" }, "structValue": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "Multi-discriminator values is already enabled in GAOS" }, "text": { @@ -49437,7 +52733,7 @@ "GenaiVertexV1beta1ResponseFormatList": { "id": "GenaiVertexV1beta1ResponseFormatList", "properties": { - "response_formats": { + "responseFormats": { "items": { "$ref": "GenaiVertexV1beta1ResponseFormat" }, @@ -49450,14 +52746,32 @@ "description": "A tool that can be used by the model to retrieve files.", "id": "GenaiVertexV1beta1Retrieval", "properties": { - "retrieval_types": { + "exa_ai_search_config": { + "$ref": "GenaiVertexV1beta1ExaAISearchConfig", + "description": "Used to specify configuration for ExaAISearch." + }, + "parallel_ai_search_config": { + "$ref": "GenaiVertexV1beta1ParallelAISearchConfig", + "description": "Used to specify configuration for ParallelAISearch." + }, + "rag_store_config": { + "$ref": "GenaiVertexV1beta1RagStoreConfig", + "description": "Used to specify configuration for RagStore." + }, + "retrievalTypes": { "description": "The types of file retrieval to enable.", "items": { "enum": [ "RETRIEVAL_TYPE_UNSPECIFIED", - "RETRIEVAL_TYPE_VERTEX_AI_SEARCH" + "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", + "RETRIEVAL_TYPE_RAG_STORE", + "RETRIEVAL_TYPE_EXA_AI_SEARCH", + "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" ], "enumDescriptions": [ + "", + "", + "", "", "" ], @@ -49472,11 +52786,105 @@ }, "type": "object" }, + "GenaiVertexV1beta1RetrievalCallDelta": { + "description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.", + "id": "GenaiVertexV1beta1RetrievalCallDelta", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", + "description": "Required. The arguments to pass to the Retrieval tool." + }, + "retrievalType": { + "description": "The type of retrieval tools.", + "enum": [ + "RETRIEVAL_TYPE_UNSPECIFIED", + "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", + "RETRIEVAL_TYPE_RAG_STORE", + "RETRIEVAL_TYPE_EXA_AI_SEARCH", + "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RetrievalCallStep": { + "description": "Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.", + "id": "GenaiVertexV1beta1RetrievalCallStep", + "properties": { + "arguments": { + "$ref": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", + "description": "Required. The arguments to pass to the retrieval tool." + }, + "retrievalType": { + "description": "The type of retrieval tools.", + "enum": [ + "RETRIEVAL_TYPE_UNSPECIFIED", + "RETRIEVAL_TYPE_VERTEX_AI_SEARCH", + "RETRIEVAL_TYPE_RAG_STORE", + "RETRIEVAL_TYPE_EXA_AI_SEARCH", + "RETRIEVAL_TYPE_PARALLEL_AI_SEARCH" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments": { + "description": "The arguments to pass to Retrieval tools.", + "id": "GenaiVertexV1beta1RetrievalCallStepRetrievalStepArguments", + "properties": { + "queries": { + "description": "Queries for Retrieval information.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RetrievalResultDelta": { + "description": "Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. ToolResultDelta.type", + "id": "GenaiVertexV1beta1RetrievalResultDelta", + "properties": { + "isError": { + "description": "Whether the retrieval resulted in an error.", + "type": "boolean" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1RetrievalResultStep": { + "description": "Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.", + "id": "GenaiVertexV1beta1RetrievalResultStep", + "properties": { + "isError": { + "description": "Whether the retrieval resulted in an error.", + "type": "boolean" + } + }, + "type": "object" + }, "GenaiVertexV1beta1ReviewSnippet": { "description": "Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.", "id": "GenaiVertexV1beta1ReviewSnippet", "properties": { - "review_id": { + "reviewId": { "description": "The ID of the review snippet.", "type": "string" }, @@ -49491,6 +52899,154 @@ }, "type": "object" }, + "GenaiVertexV1beta1SafetySetting": { + "description": "A safety setting that affects the safety-blocking behavior. A SafetySetting consists of a harm category and a threshold for that category.", + "id": "GenaiVertexV1beta1SafetySetting", + "properties": { + "method": { + "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", + "PROBABILITY" + ], + "enumDescriptions": [ + "The harm block method is unspecified.", + "The harm block method uses both probability and severity scores.", + "The harm block method uses the probability score." + ], + "type": "string" + }, + "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", + "BLOCK_MEDIUM_AND_ABOVE", + "BLOCK_ONLY_HIGH", + "BLOCK_NONE", + "OFF" + ], + "enumDescriptions": [ + "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" + }, + "type": { + "description": "Required. The type of harm category to be blocked.", + "enum": [ + "HARM_CATEGORY_UNSPECIFIED", + "HARM_CATEGORY_HATE_SPEECH", + "HARM_CATEGORY_DANGEROUS_CONTENT", + "HARM_CATEGORY_HARASSMENT", + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY", + "HARM_CATEGORY_IMAGE_HATE", + "HARM_CATEGORY_IMAGE_DANGEROUS_CONTENT", + "HARM_CATEGORY_IMAGE_HARASSMENT", + "HARM_CATEGORY_IMAGE_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_JAILBREAK" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "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.", + "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" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ServerToolCallDelta": { + "id": "GenaiVertexV1beta1ServerToolCallDelta", + "properties": { + "codeExecutionCall": { + "$ref": "GenaiVertexV1beta1CodeExecutionCallDelta" + }, + "fileSearchCall": { + "$ref": "GenaiVertexV1beta1FileSearchCallDelta" + }, + "googleMapsCall": { + "$ref": "GenaiVertexV1beta1GoogleMapsCallDelta" + }, + "googleSearchCall": { + "$ref": "GenaiVertexV1beta1GoogleSearchCallDelta" + }, + "mcpServerToolCall": { + "$ref": "GenaiVertexV1beta1McpServerToolCallDelta" + }, + "retrievalCall": { + "$ref": "GenaiVertexV1beta1RetrievalCallDelta" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextCall": { + "$ref": "GenaiVertexV1beta1UrlContextCallDelta" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1ServerToolResultDelta": { + "id": "GenaiVertexV1beta1ServerToolResultDelta", + "properties": { + "codeExecutionResult": { + "$ref": "GenaiVertexV1beta1CodeExecutionResultDelta" + }, + "fileSearchResult": { + "$ref": "GenaiVertexV1beta1FileSearchResultDelta" + }, + "googleMapsResult": { + "$ref": "GenaiVertexV1beta1GoogleMapsResultDelta" + }, + "googleSearchResult": { + "$ref": "GenaiVertexV1beta1GoogleSearchResultDelta" + }, + "mcpServerToolResult": { + "$ref": "GenaiVertexV1beta1McpServerToolResultDelta" + }, + "retrievalResult": { + "$ref": "GenaiVertexV1beta1RetrievalResultDelta" + }, + "signature": { + "description": "A signature hash for backend validation.", + "format": "byte", + "type": "string" + }, + "urlContextResult": { + "$ref": "GenaiVertexV1beta1UrlContextResultDelta" + } + }, + "type": "object" + }, "GenaiVertexV1beta1SpeechConfig": { "description": "The configuration for speech interaction.", "id": "GenaiVertexV1beta1SpeechConfig", @@ -49527,7 +53083,8 @@ "$ref": "GenaiVertexV1beta1ToolResultStep" }, "userInput": { - "$ref": "GenaiVertexV1beta1UserInputStep" + "$ref": "GenaiVertexV1beta1UserInputStep", + "description": "DO NOT USE -- These are for 3P JSON only" } }, "type": "object" @@ -49557,9 +53114,18 @@ "document": { "$ref": "GenaiVertexV1beta1DocumentDelta" }, + "functionResult": { + "$ref": "GenaiVertexV1beta1FunctionResultDelta" + }, "image": { "$ref": "GenaiVertexV1beta1ImageDelta" }, + "serverToolCall": { + "$ref": "GenaiVertexV1beta1ServerToolCallDelta" + }, + "serverToolResult": { + "$ref": "GenaiVertexV1beta1ServerToolResultDelta" + }, "text": { "$ref": "GenaiVertexV1beta1TextDelta" }, @@ -49611,6 +53177,37 @@ "index": { "format": "int32", "type": "integer" + }, + "stepUsage": { + "$ref": "GenaiVertexV1beta1InteractionUsage", + "description": "Model usage stats for this specific step." + }, + "usage": { + "$ref": "GenaiVertexV1beta1InteractionUsage", + "description": "Cumulative model usage stats from the start of the session." + } + }, + "type": "object" + }, + "GenaiVertexV1beta1StreamMetadata": { + "id": "GenaiVertexV1beta1StreamMetadata", + "properties": { + "totalUsage": { + "$ref": "GenaiVertexV1beta1InteractionUsage" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Struct": { + "description": "`Struct` represents a structured data value, consisting of fields which map to dynamically typed values.", + "id": "GenaiVertexV1beta1Struct", + "properties": { + "fields": { + "description": "Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.", + "items": { + "$ref": "GenaiVertexV1beta1Field" + }, + "type": "array" } }, "type": "object" @@ -49650,27 +53247,31 @@ "description": "Citation information for model-generated content.", "id": "GenaiVertexV1beta1TextContentAnnotation", "properties": { - "end_index": { + "endIndex": { "description": "End of the attributed segment, exclusive.", "format": "int32", "type": "integer" }, - "file_citation": { + "fileCitation": { "$ref": "GenaiVertexV1beta1FileCitation", "description": "A file citation annotation." }, - "place_citation": { + "placeCitation": { "$ref": "GenaiVertexV1beta1PlaceCitation", "description": "A place citation annotation." }, - "start_index": { + "startIndex": { "description": "Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.", "format": "int32", "type": "integer" }, - "url_citation": { + "urlCitation": { "$ref": "GenaiVertexV1beta1UrlCitation", "description": "A URL citation annotation." + }, + "wordInfo": { + "$ref": "GenaiVertexV1beta1WordInfo", + "description": "Word-level ASR annotation with timing and speaker info." } }, "type": "object" @@ -49688,7 +53289,7 @@ "description": "Configuration for text output format.", "id": "GenaiVertexV1beta1TextResponseFormat", "properties": { - "mime_type": { + "mimeType": { "description": "The MIME type of the text output.", "enum": [ "TYPE_UNSPECIFIED", @@ -49703,13 +53304,14 @@ "type": "string" }, "schema": { - "$ref": "GenaiStruct", + "$ref": "GenaiVertexV1beta1Struct", "description": "The JSON schema that the output should conform to. Only applicable when mime_type is application/json." } }, "type": "object" }, "GenaiVertexV1beta1ThoughtContent": { + "deprecated": true, "description": "A thought content block.", "id": "GenaiVertexV1beta1ThoughtContent", "properties": { @@ -49751,7 +53353,7 @@ "summary": { "description": "A summary of the thought.", "items": { - "$ref": "GenaiVertexV1beta1ThoughtSummaryContent" + "$ref": "GenaiVertexV1beta1Content" }, "type": "array" } @@ -49774,7 +53376,7 @@ "id": "GenaiVertexV1beta1ThoughtSummaryDelta", "properties": { "content": { - "$ref": "GenaiVertexV1beta1ThoughtSummaryContent", + "$ref": "GenaiVertexV1beta1Content", "description": "A new summary item to be added to the thought." } }, @@ -49824,6 +53426,7 @@ "type": "object" }, "GenaiVertexV1beta1ToolCallContent": { + "deprecated": true, "description": "Tool call content.", "id": "GenaiVertexV1beta1ToolCallContent", "properties": { @@ -49922,6 +53525,9 @@ "mcpServerToolCall": { "$ref": "GenaiVertexV1beta1McpServerToolCallStep" }, + "retrievalCall": { + "$ref": "GenaiVertexV1beta1RetrievalCallStep" + }, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -49937,7 +53543,7 @@ "description": "The tool choice configuration containing allowed tools.", "id": "GenaiVertexV1beta1ToolChoiceConfig", "properties": { - "allowed_tools": { + "allowedTools": { "$ref": "GenaiVertexV1beta1AllowedTools", "description": "The allowed tools." } @@ -49945,10 +53551,11 @@ "type": "object" }, "GenaiVertexV1beta1ToolResultContent": { + "deprecated": true, "description": "Tool result content.", "id": "GenaiVertexV1beta1ToolResultContent", "properties": { - "call_id": { + "callId": { "description": "Required. ID to match the ID from the function call block.", "type": "string" }, @@ -49984,7 +53591,7 @@ "GenaiVertexV1beta1ToolResultDelta": { "id": "GenaiVertexV1beta1ToolResultDelta", "properties": { - "call_id": { + "callId": { "description": "Required. ID to match the ID from the function call block.", "type": "string" }, @@ -50021,7 +53628,7 @@ "description": "Tool result step.", "id": "GenaiVertexV1beta1ToolResultStep", "properties": { - "call_id": { + "callId": { "description": "Required. ID to match the ID from the function call block.", "type": "string" }, @@ -50043,6 +53650,9 @@ "mcpServerToolResult": { "$ref": "GenaiVertexV1beta1McpServerToolResultStep" }, + "retrievalResult": { + "$ref": "GenaiVertexV1beta1RetrievalResultStep" + }, "signature": { "description": "A signature hash for backend validation.", "format": "byte", @@ -50054,6 +53664,46 @@ }, "type": "object" }, + "GenaiVertexV1beta1TranscriptionConfig": { + "description": "Configuration for speech recognition (transcription).", + "id": "GenaiVertexV1beta1TranscriptionConfig", + "properties": { + "adaptationPhrases": { + "deprecated": true, + "description": "Optional. A list of phrases to bias the ASR model towards.", + "items": { + "type": "string" + }, + "type": "array" + }, + "customVocabulary": { + "description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diarizationMode": { + "description": "Optional. Configures speaker diarization. Supported values: \"speaker\".", + "type": "string" + }, + "languageHints": { + "description": "Required. BCP-47 language codes providing hints about the languages present in the audio. At least one must be specified, or set to [\"auto\"] to enable automatic language detection.", + "items": { + "type": "string" + }, + "type": "array" + }, + "timestampGranularities": { + "description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GenaiVertexV1beta1Turn": { "deprecated": true, "id": "GenaiVertexV1beta1Turn", @@ -50109,6 +53759,7 @@ "type": "object" }, "GenaiVertexV1beta1UrlContextCallContent": { + "deprecated": true, "description": "URL context content.", "id": "GenaiVertexV1beta1UrlContextCallContent", "properties": { @@ -50168,10 +53819,11 @@ "type": "object" }, "GenaiVertexV1beta1UrlContextResultContent": { + "deprecated": true, "description": "URL context result content.", "id": "GenaiVertexV1beta1UrlContextResultContent", "properties": { - "is_error": { + "isError": { "description": "Whether the URL context resulted in an error.", "type": "boolean" }, @@ -50217,7 +53869,7 @@ "GenaiVertexV1beta1UrlContextResultDelta": { "id": "GenaiVertexV1beta1UrlContextResultDelta", "properties": { - "is_error": { + "isError": { "type": "boolean" }, "result": { @@ -50233,7 +53885,7 @@ "description": "URL context result step.", "id": "GenaiVertexV1beta1UrlContextResultStep", "properties": { - "is_error": { + "isError": { "description": "Whether the URL context resulted in an error.", "type": "boolean" }, @@ -50280,11 +53932,55 @@ "description": "Input provided by the user.", "id": "GenaiVertexV1beta1UserInputStep", "properties": { - "content": { - "items": { - "$ref": "GenaiVertexV1beta1Content" - }, - "type": "array" + "contentList": { + "$ref": "GenaiVertexV1beta1ContentList", + "description": "The content of the step. An array of Content objects." + }, + "contentString": { + "description": "The content of the step. A single string.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1Value": { + "description": "`Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.", + "id": "GenaiVertexV1beta1Value", + "properties": { + "boolValue": { + "description": "Represents a boolean value.", + "type": "boolean" + }, + "contentValue": { + "$ref": "GenaiVertexV1beta1Content", + "description": "Represents rich content (text, image, etc.)." + }, + "listValue": { + "$ref": "GenaiVertexV1beta1ListValue", + "description": "Represents a repeated `Value`." + }, + "nullValue": { + "description": "Represents a null value.", + "enum": [ + "NULL_VALUE" + ], + "enumDescriptions": [ + "Null value." + ], + "type": "string" + }, + "numberValue": { + "description": "Represents a double value.", + "format": "double", + "type": "number" + }, + "stringValue": { + "description": "Represents a string value.", + "type": "string" + }, + "structValue": { + "$ref": "GenaiVertexV1beta1Struct", + "description": "Represents a structured value." } }, "type": "object" @@ -50307,6 +54003,31 @@ }, "type": "object" }, + "GenaiVertexV1beta1VideoConfig": { + "description": "Configuration options for video generation.", + "id": "GenaiVertexV1beta1VideoConfig", + "properties": { + "task": { + "description": "Optional task mode for video generation. If not specified, the model automatically determines the appropriate mode based on the provided text prompt and input media.", + "enum": [ + "TASK_UNSPECIFIED", + "TEXT_TO_VIDEO", + "IMAGE_TO_VIDEO", + "REFERENCE_TO_VIDEO", + "EDIT" + ], + "enumDescriptions": [ + "Unspecified task. The task is inferred from the input prompt and media.", + "Generates video solely from a text prompt.", + "Generates video from one or two source images. The first image defines the starting frame, and the optional second image defines the ending frame.", + "Generates video using reference media (such as images, audio, or video).", + "Modifies an existing input video." + ], + "type": "string" + } + }, + "type": "object" + }, "GenaiVertexV1beta1VideoContent": { "description": "A video content block.", "id": "GenaiVertexV1beta1VideoContent", @@ -50316,7 +54037,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "description": "The mime type of the video.", "enum": [ "TYPE_UNSPECIFIED", @@ -50376,7 +54097,7 @@ "format": "byte", "type": "string" }, - "mime_type": { + "mimeType": { "enum": [ "TYPE_UNSPECIFIED", "TYPE_MP4", @@ -50430,7 +54151,70 @@ "GenaiVertexV1beta1VideoResponseFormat": { "description": "Configuration for video output format.", "id": "GenaiVertexV1beta1VideoResponseFormat", - "properties": {}, + "properties": { + "aspectRatio": { + "description": "The aspect ratio for the video output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_NINE_BY_SIXTEEN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "16:9 aspect ratio.", + "9:16 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "The delivery mode for the video output.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Video data is returned inline in the response.", + "Video data is returned as a URI." + ], + "type": "string" + }, + "duration": { + "description": "The duration for the video output.", + "format": "google-duration", + "type": "string" + }, + "gcsUri": { + "description": "The GCS URI to store the video output. Required for Vertex if delivery mode is URI.", + "type": "string" + } + }, + "type": "object" + }, + "GenaiVertexV1beta1WordInfo": { + "description": "Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.", + "id": "GenaiVertexV1beta1WordInfo", + "properties": { + "endOffset": { + "description": "End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", + "format": "google-duration", + "type": "string" + }, + "speaker": { + "description": "Optional. Speaker label for this word (e.g. \"spk_1\", \"spk_2\"). Present when diarization_mode is set in TranscriptionConfig.", + "type": "string" + }, + "startOffset": { + "description": "Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains \"word\".", + "format": "google-duration", + "type": "string" + }, + "text": { + "description": "The transcribed word.", + "type": "string" + } + }, "type": "object" }, "GoogleApiHttpBody": { @@ -50460,10 +54244,66 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1A2aPart": { + "description": "A single part of a message or artifact. A part carries exactly one kind of content.", + "id": "GoogleCloudAiplatformV1beta1A2aPart", + "properties": { + "data": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Structured data content.", + "type": "object" + }, + "filename": { + "description": "Optional. The name of the file, when the part represents a file.", + "type": "string" + }, + "mediaType": { + "description": "Optional. The IANA media type of the content, e.g. \"text/plain\" or \"image/png\".", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional context or parameters related to the part. Extensions can be used to strongly type metadata values for specific use cases.", + "type": "object" + }, + "raw": { + "description": "Optional. Raw binary content.", + "format": "byte", + "type": "string" + }, + "text": { + "description": "Optional. Textual content.", + "type": "string" + }, + "url": { + "description": "Optional. A URL pointing to the content.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1A2aTask": { "description": "An A2aTask represents a unit of work.", "id": "GoogleCloudAiplatformV1beta1A2aTask", "properties": { + "appId": { + "description": "Optional. Agent application which created the task.", + "type": "string" + }, + "artifacts": { + "description": "Output only. The artifacts produced by the task.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact" + }, + "readOnly": true, + "type": "array" + }, "contextId": { "description": "Optional. A generic identifier for grouping related tasks (e.g., session_id, workflow_id).", "type": "string" @@ -50479,6 +54319,20 @@ "format": "google-datetime", "type": "string" }, + "generation": { + "description": "Output only. The task generation number.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "history": { + "description": "Output only. The history of the task messages.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage" + }, + "readOnly": true, + "type": "array" + }, "metadata": { "additionalProperties": { "description": "Properties of the object.", @@ -50488,7 +54342,7 @@ "type": "object" }, "name": { - "description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}`", + "description": "Identifier. The resource name of the task. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/a2aTasks/{a2a_task}` or `projects/{project}/locations/{location}/taskStores/{task_store}/a2aTasks/{a2a_task}`", "type": "string" }, "nextEventSequenceNumber": { @@ -50530,6 +54384,11 @@ "readOnly": true, "type": "string" }, + "status": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatus", + "description": "Output only. The status of the task, including the state, status message, and timestamp.", + "readOnly": true + }, "statusDetails": { "$ref": "GoogleCloudAiplatformV1beta1TaskStatusDetails", "description": "Optional. The status details of the task." @@ -50544,6 +54403,296 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "userId": { + "description": "Optional. Task owner user ID.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskArtifact": { + "description": "Represents a single artifact produced by a task.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", + "properties": { + "artifactId": { + "description": "Required. The unique identifier of the artifact within the task.", + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the artifact.", + "type": "string" + }, + "displayName": { + "description": "Optional. The human-readable name of the artifact.", + "type": "string" + }, + "extensions": { + "description": "Optional. A2A protocol extensions associated with the artifact.", + "items": { + "type": "string" + }, + "type": "array" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional context or parameters related to the artifact. Extensions can be used to strongly type metadata values for specific use cases.", + "type": "object" + }, + "parts": { + "description": "Required. The content parts that make up the artifact.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aPart" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange": { + "description": "An event payload describing a change to one of the task's artifacts.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange", + "properties": { + "append": { + "description": "Optional. Whether the artifact parts should be appended to an existing artifact rather than replacing it.", + "type": "boolean" + }, + "artifact": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifact", + "description": "Required. The artifact that was added or updated." + }, + "lastChunk": { + "description": "Optional. Whether this is the last chunk of a streamed artifact.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskEvent": { + "description": "An event that records a single change applied to a task's state.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskEvent", + "properties": { + "createTime": { + "description": "Output only. The time at which the event was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "eventData": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEventData", + "description": "Required. The data describing the change carried by this event." + }, + "generation": { + "description": "Output only. The generation number of the task after this event is applied.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional context or parameters related to the event. Extensions can be used to strongly type metadata values for specific use cases.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskEventData": { + "description": "The data describing the change carried by an A2aTaskEvent. Exactly one of the following changes is set per event.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskEventData", + "properties": { + "artifactChange": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskArtifactChange", + "description": "Optional. A change to one of the task's artifacts." + }, + "historyAppend": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", + "description": "Optional. A new message appended to the task history." + }, + "metadataChange": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange", + "description": "Optional. A change to the task-level metadata." + }, + "statusUpdate": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate", + "description": "Optional. An update to the task's state and status message." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend": { + "description": "An event payload that appends a new message to the task history.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskHistoryAppend", + "properties": { + "message": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", + "description": "Required. The message to append to the task history." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskMessage": { + "description": "Represents a single message in a conversation, compliant with the A2A specification.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskMessage", + "properties": { + "extensions": { + "description": "Optional. A2A protocol extensions associated with the message.", + "items": { + "type": "string" + }, + "type": "array" + }, + "messageId": { + "description": "Required. The unique identifier of the message.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. Additional context or parameters related to the message. Extensions can be used to strongly type metadata values for specific use cases.", + "type": "object" + }, + "parts": { + "description": "Required. The content parts that make up the message.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aPart" + }, + "type": "array" + }, + "referenceTaskIds": { + "description": "Optional. The IDs of other tasks referenced by this message.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Required. The role of the sender of the message.", + "enum": [ + "ROLE_UNSPECIFIED", + "ROLE_USER", + "ROLE_AGENT" + ], + "enumDescriptions": [ + "The role is unspecified.", + "The message is from the client to the server.", + "The message is from the server to the client." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange": { + "description": "An event payload describing a change to the task-level metadata.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskMetadataChange", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Required. The complete task metadata after the change.", + "type": "object" + }, + "updateMask": { + "description": "Optional. A field mask indicating which metadata paths changed. If unset, all fields are updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskStatus": { + "description": "Represents the status of an A2aTask.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskStatus", + "properties": { + "message": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", + "description": "Output only. The status message associated with the state.", + "readOnly": true + }, + "state": { + "description": "Output only. The current state of the task.", + "enum": [ + "STATE_UNSPECIFIED", + "TASK_STATE_SUBMITTED", + "TASK_STATE_WORKING", + "TASK_STATE_COMPLETED", + "TASK_STATE_FAILED", + "TASK_STATE_CANCELED", + "TASK_STATE_INPUT_REQUIRED", + "TASK_STATE_REJECTED", + "TASK_STATE_AUTH_REQUIRED" + ], + "enumDescriptions": [ + "The task is in an unknown or indeterminate state.", + "Indicates that a task has been successfully submitted and acknowledged.", + "Indicates that a task is actively being processed by the agent.", + "Indicates that a task has finished successfully. This is a terminal state.", + "Indicates that a task has finished with an error. This is a terminal state.", + "Indicates that a task was canceled before completion. This is a terminal state.", + "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", + "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", + "Indicates that authentication is required to proceed. This is an interrupted state." + ], + "readOnly": true, + "type": "string" + }, + "timestamp": { + "description": "Output only. The time at which the state was set.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate": { + "description": "An event payload that updates the task's state and optional status message.", + "id": "GoogleCloudAiplatformV1beta1A2aTaskStatusUpdate", + "properties": { + "message": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskMessage", + "description": "Optional. The status message associated with the state change." + }, + "state": { + "description": "Required. The new state of the task.", + "enum": [ + "STATE_UNSPECIFIED", + "TASK_STATE_SUBMITTED", + "TASK_STATE_WORKING", + "TASK_STATE_COMPLETED", + "TASK_STATE_FAILED", + "TASK_STATE_CANCELED", + "TASK_STATE_INPUT_REQUIRED", + "TASK_STATE_REJECTED", + "TASK_STATE_AUTH_REQUIRED" + ], + "enumDescriptions": [ + "The task is in an unknown or indeterminate state.", + "Indicates that a task has been successfully submitted and acknowledged.", + "Indicates that a task is actively being processed by the agent.", + "Indicates that a task has finished successfully. This is a terminal state.", + "Indicates that a task has finished with an error. This is a terminal state.", + "Indicates that a task was canceled before completion. This is a terminal state.", + "Indicates that the agent requires additional user input to proceed. This is an interrupted state.", + "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", + "Indicates that authentication is required to proceed. This is an interrupted state." + ], + "type": "string" + }, + "timestamp": { + "description": "Optional. The time at which the status change occurred.", + "format": "google-datetime", + "type": "string" } }, "type": "object" @@ -50684,15 +54833,15 @@ "id": "GoogleCloudAiplatformV1beta1Agent", "properties": { "base_agent": { - "description": "Required. The base agent of the agent. Supported values: - \"antigravity-preview-05-2026\"", + "description": "Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026`", "type": "string" }, "base_environment": { - "description": "Optional. The environment config of the agent. Valid types are: - string value for environment_id, or 'remote' for default - struct value for EnvironmentConfig.", + "description": "Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`.", "type": "any" }, "created": { - "description": "Output only. Timestamp when the agent was created.", + "description": "Output only. The time the agent was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -50702,38 +54851,38 @@ "type": "string" }, "id": { - "description": "Immutable. The ID to use for agent, which will become the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, the last character must be a letter or number.", + "description": "Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, - "description": "Optional. The metadata of the agent.", + "description": "Optional. The metadata for the agent.", "type": "object" }, "name": { - "description": "Identifier. The resource name of the Agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", + "description": "Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`.", "type": "string" }, "object": { - "description": "Output only. The object type of this resource. Always set to \"agent\" in this case.", + "description": "Output only. The object type of the resource. For agents, the value is `agent`.", "readOnly": true, "type": "string" }, "system_instruction": { - "description": "Optional. The detailed struction that the agent should follow. The instruction is passed to LLM as system instruction.", + "description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", "type": "string" }, "tools": { - "description": "Optional. A list of tools that are available for the agent during the process of execucting the task.", + "description": "Optional. The tools available to the agent.", "items": { "$ref": "GoogleCloudAiplatformV1beta1AgentTool" }, "type": "array" }, "updated": { - "description": "Output only. Timestamp when the agent was last updated.", + "description": "Output only. The time the agent was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -50741,6 +54890,56 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope": { + "description": "Represents an Agent Anomaly Detection Scope.", + "id": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope", + "properties": { + "displayName": { + "description": "Optional. User-provided display name of the AgentAnomalyDetectionScope.", + "type": "string" + }, + "logBuckets": { + "description": "Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}`", + "type": "string" + }, + "observabilityBuckets": { + "description": "Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. The lifecycle state of the scope.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "The default value. This value is unused.", + "The scope is being created and is not yet usable.", + "The scope is active and usable.", + "The scope is being deleted.", + "Creation or deletion failed. The scope is not usable and must be deleted before a new scope can be created in the same region.", + "The scope is being updated." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AgentConfig": { "description": "Represents configuration for an Agent.", "id": "GoogleCloudAiplatformV1beta1AgentConfig", @@ -50834,28 +55033,162 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AgentResource": { + "description": "Defines the identity of an agent being monitored.", + "id": "GoogleCloudAiplatformV1beta1AgentResource", + "properties": { + "agent": { + "description": "Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", + "type": "string" + }, + "agentFramework": { + "description": "Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`.", + "enum": [ + "AGENT_FRAMEWORK_UNSPECIFIED", + "ADK" + ], + "enumDescriptions": [ + "The default value, used when the framework is unspecified.", + "The agent is built with the Agent Development Kit (ADK)." + ], + "type": "string" + }, + "agentType": { + "description": "Required. The runtime type of the agent.", + "enum": [ + "AGENT_TYPE_UNSPECIFIED", + "REASONING_ENGINE", + "CLOUD_RUN_SERVICE", + "GKE_WORKLOAD", + "GCE_INSTANCE", + "AGENT_TYPE_OTHER" + ], + "enumDescriptions": [ + "The default value, used when the runtime type is unspecified.", + "The agent runs on the Gemini Enterprise Agent Platform Agent Runtime (Reasoning Engine).", + "The agent runs as a Google Cloud Run service.", + "The agent runs as a workload on Google Kubernetes Engine.", + "The agent runs on a Compute Engine instance.", + "The agent runs on another runtime, such as a self-hosted, on-premises, or non-Google Cloud environment, or any runtime not represented by the values above." + ], + "type": "string" + }, + "location": { + "description": "Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`).", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AgentTool": { - "description": "A tool provides a list of actions that are available for the Agent during the process of executing the task.", + "description": "A tool provides a list of actions available to the Agent during the process of executing a task.", "id": "GoogleCloudAiplatformV1beta1AgentTool", "properties": { "headers": { "additionalProperties": { "type": "string" }, - "description": "Optional. Headers for the MCP server (e.g., authentication). Only applicable when `type` is \"mcp\".", + "description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", "type": "object" }, "name": { - "description": "Optional. The name of the MCP server. Only applicable when `type` is \"mcp\".", + "description": "Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`.", "type": "string" }, "type": { - "description": "Required. Type of the tool. Supported types: - \"code_execution\" - \"filesystem\" - \"google_search\" - \"mcp\" - \"url_context\"", + "description": "Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context`", "type": "string" }, "url": { - "description": "Optional. The full URL for the MCP server endpoint. Only applicable when `type` is \"mcp\".", + "description": "Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse": { + "description": "Contains aggregated AnalyzedSession statistics, grouped by MonitoredAgent.", + "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponse", + "properties": { + "agentAggregates": { + "description": "Aggregated statistics — exactly one entry per unique MonitoredAgent matched by the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "summary": { + "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary", + "description": "Overall summary across every MonitoredAgent included in the response." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate": { + "description": "Contains aggregated statistics for one MonitoredAgent.", + "id": "GoogleCloudAiplatformV1beta1AggregateAnalyzedSessionsResponseAgentAggregate", + "properties": { + "agentDisplayName": { + "description": "Output only. The human-readable display name of the MonitoredAgent.", + "readOnly": true, + "type": "string" + }, + "agentResourceName": { + "description": "The agent resource name. Format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`", "type": "string" + }, + "agentStatus": { + "description": "Output only. The enablement state of the MonitoredAgent (for example, ACTIVE, DISABLED, or ENABLING).", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "ACTIVE", + "ENABLING", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The agent is successfully enabled and active.", + "The agent is in the process of being enabled.", + "The agent is disabled." + ], + "readOnly": true, + "type": "string" + }, + "anomalousSessionsCount": { + "description": "The number of anomalous (SESSION_STATE_FLAGGED) sessions for this agent.", + "format": "int32", + "type": "integer" + }, + "latestSessionTime": { + "description": "The latest session update_time observed for this agent.", + "format": "google-datetime", + "type": "string" + }, + "location": { + "description": "Output only. The Google Cloud location (region) of the agent (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", + "readOnly": true, + "type": "string" + }, + "monitoredAgent": { + "description": "The MonitoredAgent resource name. Format: `projects/{project}/locations/{location}/monitoredAgents/{monitored_agent}`", + "type": "string" + }, + "severities": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" + }, + "description": "Map of severity level (string representation of Severity) to detector summaries aggregated across all sessions for this agent. The key is the string representation of Severity enum: \"SEVERITY_UNSPECIFIED\", \"SEVERITY_CRITICAL\", \"SEVERITY_HIGH\", \"SEVERITY_MEDIUM\", \"SEVERITY_LOW\".", + "type": "object" + }, + "totalSessionsCount": { + "description": "The number of analyzed sessions for this agent matched by the request.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -50939,6 +55272,177 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AnalyzedInvocation": { + "description": "Represents an analyzed invocation for a monitored agent's session.", + "id": "GoogleCloudAiplatformV1beta1AnalyzedInvocation", + "properties": { + "assessment": { + "$ref": "GoogleCloudAiplatformV1beta1Assessment", + "description": "Output only. The assessment of the invocation.", + "readOnly": true + }, + "invocationId": { + "description": "Output only. The invocation ID.", + "readOnly": true, + "type": "string" + }, + "invocationState": { + "description": "Output only. The state of the invocation.", + "enum": [ + "INVOCATION_STATE_UNSPECIFIED", + "INVOCATION_STATE_ANOMALOUS", + "INVOCATION_STATE_NOT_ANOMALOUS" + ], + "enumDescriptions": [ + "Unspecified state.", + "The invocation is anomalous.", + "The invocation is not anomalous." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the AnalyzedInvocation.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AnalyzedSession": { + "description": "Represents an analyzed session for a monitored agent.", + "id": "GoogleCloudAiplatformV1beta1AnalyzedSession", + "properties": { + "agentDisplayName": { + "description": "Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier.", + "readOnly": true, + "type": "string" + }, + "agentResourceName": { + "description": "Output only. The agent resource name. Format: `projects/{project}/locations/{location}/reasoningEngines/{agent}`", + "readOnly": true, + "type": "string" + }, + "agentState": { + "description": "Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown.", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "ACTIVE", + "ENABLING", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The agent is successfully enabled and active.", + "The agent is in the process of being enabled.", + "The agent is disabled." + ], + "readOnly": true, + "type": "string" + }, + "assessment": { + "$ref": "GoogleCloudAiplatformV1beta1Assessment", + "description": "Output only. Overall security assessment. Populated only in FULL view.", + "readOnly": true + }, + "createTime": { + "description": "Output only. The creation time of the session.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "latestAnalyzedTime": { + "description": "Output only. The latest analyzed time of the session.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Output only. The Google Cloud location (region) of the agent that ran this session (for example, `us-central1`). Empty when the agent is not enrolled or its location is unknown.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the AnalyzedSession.", + "type": "string" + }, + "sessionId": { + "description": "Output only. The session ID.", + "readOnly": true, + "type": "string" + }, + "sessionState": { + "description": "Output only. The state of the session.", + "enum": [ + "SESSION_STATE_UNSPECIFIED", + "SESSION_STATE_UNANALYZED", + "SESSION_STATE_NOT_FLAGGED", + "SESSION_STATE_FLAGGED", + "SESSION_STATE_LLM_UNFLAGGED" + ], + "enumDescriptions": [ + "The session state is unspecified.", + "The session has not yet been analyzed.", + "The session has been analyzed and no anomalies were flagged.", + "The session has been analyzed and at least one anomaly was flagged.", + "The session was analyzed by the LLM judge, which did not flag any anomalies." + ], + "readOnly": true, + "type": "string" + }, + "severities": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" + }, + "description": "Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only.", + "readOnly": true, + "type": "object" + }, + "userId": { + "description": "Output only. The user ID.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary": { + "description": "Breaks down anomalies by severity.", + "id": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary", + "properties": { + "detectorIds": { + "description": "The list of detectors summaries for this severity level.", + "items": { + "type": "string" + }, + "type": "array" + }, + "sessionsCount": { + "description": "Output only. The number of distinct sessions whose maximum severity equals `severity_level`. Each session is counted in exactly one bucket (its highest severity). Scope depends on where this appears: a global count on `AggregateAnalyzedSessionsResponse.summary`, per-agent on `agent_aggregates` entries, and page-scoped on `ListAnalyzedSessionsResponse`.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "severityLevel": { + "description": "The severity level of the detector.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "SEVERITY_LOW", + "SEVERITY_MEDIUM", + "SEVERITY_HIGH", + "SEVERITY_CRITICAL" + ], + "enumDescriptions": [ + "Unspecified severity.", + "Low severity.", + "Medium severity.", + "High severity.", + "Critical severity." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Annotation": { "description": "Used to assign specific AnnotationSpec to a particular area of a DataItem or the whole part of the DataItem.", "id": "GoogleCloudAiplatformV1beta1Annotation", @@ -51046,11 +55550,23 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest": { - "description": "Request message for AgentEngineTaskStoreService.AppendA2aTaskEvents.", + "description": "Request message for AppendA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsRequest", "properties": { + "events": { + "description": "Optional. The events to append. Used only if the parent is a TaskStore.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" + }, + "type": "array" + }, + "generation": { + "description": "Optional. The current task generation.", + "format": "int64", + "type": "string" + }, "taskEvents": { - "description": "Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown.", + "description": "Required. The events to append. The number of events to append must be less than or equal to 100. Otherwise, an exception will be thrown. Used only if the parent is a ReasoningEngine.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" }, @@ -51060,9 +55576,15 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse": { - "description": "Response message for AgentEngineTaskStoreService.AppendA2aTaskEvents.", + "description": "Response message for AppendA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1AppendA2aTaskEventsResponse", - "properties": {}, + "properties": { + "generation": { + "description": "Task generation matching the last event", + "format": "int64", + "type": "string" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1AppendEventResponse": { @@ -51301,6 +55823,69 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Assessment": { + "description": "Contains the detailed assessment for an analyzed session.", + "id": "GoogleCloudAiplatformV1beta1Assessment", + "properties": { + "detectorFindings": { + "description": "The list of detector findings.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding": { + "description": "The details of a detector's assessment within an analyzed session.", + "id": "GoogleCloudAiplatformV1beta1AssessmentDetectorFinding", + "properties": { + "detectorId": { + "description": "The detector ID.", + "type": "string" + }, + "displayName": { + "description": "The detector display name.", + "type": "string" + }, + "explanation": { + "description": "The explanation of the finding.", + "type": "string" + }, + "probability": { + "description": "The probability that this finding is an anomaly, in the range [0.0, 1.0].", + "format": "double", + "type": "number" + }, + "recommendations": { + "description": "The list of recommendations for this detector finding.", + "items": { + "type": "string" + }, + "type": "array" + }, + "severity": { + "description": "The severity of the finding.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "SEVERITY_LOW", + "SEVERITY_MEDIUM", + "SEVERITY_HIGH", + "SEVERITY_CRITICAL" + ], + "enumDescriptions": [ + "Unspecified severity.", + "Low severity.", + "Medium severity.", + "High severity.", + "Critical severity." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.AssignNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata", @@ -51417,6 +56002,160 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AudioResponseFormat": { + "description": "Configuration for audio-specific output formatting.", + "id": "GoogleCloudAiplatformV1beta1AudioResponseFormat", + "properties": { + "bitRate": { + "description": "Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).", + "format": "int32", + "type": "integer" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "mimeType": { + "description": "Optional. The MIME type of the audio output.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "AUDIO_MP3", + "AUDIO_OGG_OPUS", + "AUDIO_L16", + "AUDIO_WAV", + "AUDIO_ALAW", + "AUDIO_MULAW" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "MP3 audio format.", + "OGG Opus audio format.", + "Raw PCM (L16) audio format.", + "WAV audio format.", + "A-law audio format.", + "Mu-law audio format." + ], + "type": "string" + }, + "sampleRate": { + "description": "Optional. Sample rate for the generated audio in Hertz.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AudioTranscription": { + "description": "The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label.", + "id": "GoogleCloudAiplatformV1beta1AudioTranscription", + "properties": { + "speakerLabel": { + "description": "Optional. A label identifying the speaker of this audio segment (e.g. \"spk_1\", \"spk_2\"). Present when diarization is set.", + "type": "string" + }, + "text": { + "description": "Required. The transcription text of this audio segment.", + "type": "string" + }, + "words": { + "description": "Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig": { + "description": "Configuration for speech recognition (transcription).", + "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", + "properties": { + "adaptationPhrases": { + "deprecated": true, + "description": "Optional. A list of phrases to bias the ASR model towards.", + "items": { + "type": "string" + }, + "type": "array" + }, + "customVocabulary": { + "description": "Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diarization": { + "description": "Optional. Configures speaker diarization.", + "type": "boolean" + }, + "languageAuto": { + "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", + "description": "Optional. The model will detect the language automatically." + }, + "languageHints": { + "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", + "description": "Optional. Specifies one or more languages in the audio." + }, + "wordTimestamp": { + "description": "Optional. Configures word-level timestamp generation.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto": { + "description": "Indicates the language of the audio should be automatically detected.", + "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageAuto", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints": { + "description": "Provides hints to the model about possible languages present in the audio.", + "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfigLanguageHints", + "properties": { + "languageCodes": { + "description": "Required. BCP-47 language codes. At least one must be specified.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo": { + "description": "Information about a single recognized word.", + "id": "GoogleCloudAiplatformV1beta1AudioTranscriptionWordInfo", + "properties": { + "endOffset": { + "description": "Optional. End offset in time of the word relative to the start of the audio.", + "format": "google-duration", + "type": "string" + }, + "startOffset": { + "description": "Optional. Start offset in time of the word relative to the start of the audio.", + "format": "google-duration", + "type": "string" + }, + "word": { + "description": "Required. Transcript of the word.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AugmentPromptRequest": { "description": "Request message for AugmentPrompt.", "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequest", @@ -51616,11 +56355,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1AutomaticResources": { - "description": "A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", + "description": "A description of resources that to large degree are decided by Agent Platform, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines.", "id": "GoogleCloudAiplatformV1beta1AutomaticResources", "properties": { "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number.", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Agent Platform may be unable to scale beyond certain replica number.", "format": "int32", "type": "integer" }, @@ -51863,7 +56602,7 @@ "type": "boolean" }, "startingReplicaCount": { - "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count", + "description": "Immutable. The number of machine replicas used at the start of the batch operation. If not set, Agent Platform decides starting number, not greater than max_replica_count", "format": "int32", "type": "integer" } @@ -52088,6 +56827,10 @@ "readOnly": true, "type": "string" }, + "endpoint": { + "description": "For Bring-Your-Own-Endpoint (BYOE), the name of the Endpoint resource that produces the predictions via this job, must share the same ancestor Location. Exactly one of model, unmanaged_container_model, or endpoint must be set. Example: `projects/193595526740/locations/us-central1/endpoints/4203439000301600768`", + "type": "string" + }, "error": { "$ref": "GoogleRpcStatus", "description": "Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.", @@ -52982,6 +57725,11 @@ "description": "Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest.", "type": "string" }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Error while evaluating the candidate for the metric.", + "readOnly": true + }, "explanation": { "description": "Optional. The explanation for the metric.", "type": "string" @@ -53212,10 +57960,59 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CloudLoggingConfig": { + "description": "Specifies configuration for exporting evaluation results to Cloud Logging.", + "id": "GoogleCloudAiplatformV1beta1CloudLoggingConfig", + "properties": { + "project": { + "description": "Optional. Google Cloud project to write logs to. Defaults to the request project.", + "type": "string" + }, + "resourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location.", + "type": "object" + }, + "resourceType": { + "description": "Optional. MonitoredResource type. Defaults to \"global\" if unspecified.", + "type": "string" + }, + "tracingContext": { + "$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext", + "description": "Optional. Tracing context for the evaluation run." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext": { + "description": "Tracing context for Observability correlation.", + "id": "GoogleCloudAiplatformV1beta1CloudLoggingConfigTracingContext", + "properties": { + "conversationId": { + "description": "Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes.", + "type": "string" + }, + "spanId": { + "description": "Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated.", + "type": "string" + }, + "traceId": { + "description": "Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CodeExecutionResult": { "description": "Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used.", "id": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "properties": { + "id": { + "description": "Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id.", + "type": "string" + }, "outcome": { "description": "Required. Outcome of the code execution.", "enum": [ @@ -53441,6 +58238,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig": { + "description": "Composite reward function configuration for reinforcement tuning.", + "id": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig", + "properties": { + "weightedRewardConfigs": { + "description": "List of reward function configurations with weights.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig": { + "description": "Reward function configuration with a weight. The weight is used to combine the reward with other rewards.", + "id": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfigWeightedRewardConfig", + "properties": { + "rewardConfig": { + "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", + "description": "Single reward configuration." + }, + "weight": { + "description": "How much this single reward contributes to the total overall reward. Total reward is a linear combination of single rewards with their corresponding weights, i.e., ``` total_reward = ( weight_a * reward_a + weight_b * reward_b + ... ) / (weight_a + weight_b + ...) ```", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ComputationBasedMetricSpec": { "description": "Specification for a computation based metric.", "id": "GoogleCloudAiplatformV1beta1ComputationBasedMetricSpec", @@ -55042,6 +59869,11 @@ "description": "Statistics computed over a tuning dataset.", "id": "GoogleCloudAiplatformV1beta1DatasetStats", "properties": { + "contentsPerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", + "description": "Output only. Dataset distributions for the number of contents per example.", + "readOnly": true + }, "droppedExampleIndices": { "description": "Output only. A partial sample of the indices (starting from 1) of the dropped examples.", "items": { @@ -55059,12 +59891,23 @@ "readOnly": true, "type": "array" }, + "reinforcementTuningUserDatasetExamples": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples", + "description": "Output only. Sample user dataset examples in the training dataset uri for Reinforcement Tuning.", + "readOnly": true + }, "totalBillableCharacterCount": { "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "format": "int64", @@ -55191,7 +60034,7 @@ "description": "Required. Immutable. The specification of a single machine being used." }, "maxReplicaCount": { - "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", + "description": "Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Agent Platform CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type).", "format": "int32", "type": "integer" }, @@ -56005,6 +60848,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest": { + "description": "Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine.", + "id": "GoogleCloudAiplatformV1beta1DeprovisionSemanticGovernancePolicyEngineRequest", + "properties": { + "force": { + "description": "Optional. If true, the operation bypass checks on current state and force the deprovisioning operation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DestinationFeatureSetting": { "id": "GoogleCloudAiplatformV1beta1DestinationFeatureSetting", "properties": { @@ -56089,6 +60943,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest": { + "description": "Request message for AgentAnomalyDetectionService.DisableMonitoredAgent.", + "id": "GoogleCloudAiplatformV1beta1DisableMonitoredAgentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DiskSpec": { "description": "Represents the spec of disk options.", "id": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -56465,6 +61325,12 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest": { + "description": "Request message for AgentAnomalyDetectionService.EnableMonitoredAgent.", + "id": "GoogleCloudAiplatformV1beta1EnableMonitoredAgentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1EncryptionSpec": { "description": "Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource.", "id": "GoogleCloudAiplatformV1beta1EncryptionSpec", @@ -56564,6 +61430,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, + "publisherModelConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig", + "description": "Optional. Configuration for a Publisher Model. This message contains details about a publisher model used with this Endpoint, such as logging config or data sharing settings." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -56856,7 +61726,7 @@ "properties": { "autoraterConfig": { "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", - "description": "Optional. Autorater config used for evaluation." + "description": "Optional. Autorater config used for evaluation. Not applicable for predefined metrics (PredefinedMetricSpec); the server uses its own model configuration for predefined metrics and this field is ignored." }, "bleuInput": { "$ref": "GoogleCloudAiplatformV1beta1BleuInput", @@ -57629,6 +62499,10 @@ "description": "Required. The user-friendly display name for the EvaluationMetric.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key." + }, "gcsUri": { "description": "Optional. The Google Cloud Storage URI that stores the metric specification..", "type": "string" @@ -57958,6 +62832,10 @@ "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig", "description": "Optional. The autorater config for the evaluation run." }, + "cloudLoggingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1CloudLoggingConfig", + "description": "Optional. Configuration for exporting evaluation results to Cloud Logging." + }, "datasetCustomMetrics": { "description": "Optional. Specifications for custom dataset-level aggregations.", "items": { @@ -58079,6 +62957,10 @@ "description": "Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used.", "format": "int32", "type": "integer" + }, + "promptTemplate": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigPromptTemplate", + "description": "Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used." } }, "type": "object" @@ -58394,6 +63276,10 @@ "description": "Required. The display name of the EvaluationSet.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key." + }, "evaluationItems": { "description": "Required. The EvaluationItems that are part of this dataset.", "items": { @@ -58845,6 +63731,10 @@ "description": "Required. The code to be executed.", "type": "string" }, + "id": { + "description": "Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`.", + "type": "string" + }, "language": { "description": "Required. Programming language of the `code`.", "enum": [ @@ -59814,6 +64704,21 @@ "description": "Output only. The region of the project.", "readOnly": true, "type": "string" + }, + "tier": { + "description": "Output only. The tier of the project.", + "enum": [ + "TIER_UNSPECIFIED", + "TIER_FREE", + "TIER_PAID" + ], + "enumDescriptions": [ + "Not specified.", + "Free tier - initial tier for managed project.", + "Paid tier is assigned to managed project after the upgrade." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -61646,6 +66551,94 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeedbackContext": { + "description": "Feedback context is a resource that represents additional information about the conversation where the feedback was given, such as the conversation history, system instructions, etc. If provided, feedback context allows to correlate the feedback with the conversation, even if the original session is deleted or not available.", + "id": "GoogleCloudAiplatformV1beta1FeedbackContext", + "properties": { + "contextEvents": { + "description": "Optional. The session events from the originating session.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SessionEvent" + }, + "type": "array" + }, + "name": { + "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}/feedbackContext`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeedbackEntry": { + "description": "FeedbackEntry is a resource that represents a user's feedback on a conversation with an agent.", + "id": "GoogleCloudAiplatformV1beta1FeedbackEntry", + "properties": { + "createTime": { + "description": "Output only. The time at which the entry was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Additional key-value metadata associated with the feedback.", + "type": "object" + }, + "eventId": { + "description": "Required. The ID of the event within the session that the feedback relates to.", + "type": "string" + }, + "feedbackLabels": { + "items": { + "type": "string" + }, + "type": "array" + }, + "feedbackText": { + "description": "Optional. Qualitative free-form comments provided by the user.", + "type": "string" + }, + "feedbackType": { + "description": "Required. The coarse-grained type of feedback provided by the user. Must be set to a value other than `FEEDBACK_TYPE_UNSPECIFIED`.", + "enum": [ + "FEEDBACK_TYPE_UNSPECIFIED", + "THUMBS_UP", + "THUMBS_DOWN" + ], + "enumDescriptions": [ + "This is the default value meaning the type has not been set.", + "Indicates positive feedback.", + "Indicates negative feedback." + ], + "type": "string" + }, + "name": { + "description": "Identifier. The resource name. Assigned by the server on create. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/feedbackEntries/{feedback_entry}`", + "type": "string" + }, + "sessionId": { + "description": "Required. The ID of the session that the feedback relates to.", + "type": "string" + }, + "source": { + "description": "Optional. The surface that the feedback originated from.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time at which the entry was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "userId": { + "description": "Optional. A caller-supplied identifier for the user who provided the feedback. The semantics of this field (for example whether it is an opaque token, a hashed value, or a user-visible identifier) are determined by the calling application.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FetchExamplesRequest": { "description": "Request message for ExampleStoreService.FetchExamples.", "id": "GoogleCloudAiplatformV1beta1FetchExamplesRequest", @@ -62408,6 +67401,68 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GatewayConfig": { + "description": "Configuration for a single gateway.", + "id": "GoogleCloudAiplatformV1beta1GatewayConfig", + "properties": { + "allowedProjects": { + "description": "Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the \"decoupled\" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number.", + "items": { + "type": "string" + }, + "type": "array" + }, + "dnsRecord": { + "description": "Output only. The fully qualified record name of the created A-record in Cloud DNS.", + "readOnly": true, + "type": "string" + }, + "dnsZoneName": { + "description": "Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint.", + "type": "string" + }, + "ipAddress": { + "description": "Output only. The private IP address of the PSC endpoint.", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "pscEndpoint": { + "description": "Output only. The self-link or name of the Private Service Connect endpoint forwarding rule.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the Gateway configuration.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "ACTIVE", + "DEPROVISIONING", + "INACTIVE", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The Gateway is being provisioned.", + "The Gateway is active and ready to use.", + "The Gateway is being de-provisioned.", + "The Gateway is inactive.", + "The Gateway failed to be provisioned." + ], + "readOnly": true, + "type": "string" + }, + "subnetwork": { + "description": "Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location} Format: projects/{project}/regions/{region}/subnetworks/{subnetwork}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GcsDestination": { "description": "The Google Cloud Storage location where the output is to be written to.", "id": "GoogleCloudAiplatformV1beta1GcsDestination", @@ -63209,7 +68264,7 @@ "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AgentConfig" }, - "description": "Required. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent.", + "description": "Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent.", "type": "object" }, "allowCrossRegionModel": { @@ -63217,7 +68272,7 @@ "type": "boolean" }, "rootAgentId": { - "description": "Required. The agent id to identify the root agent.", + "description": "Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent.", "type": "string" }, "userScenarioGenerationConfig": { @@ -63302,6 +68357,10 @@ "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" }, + "audioTranscriptionConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AudioTranscriptionConfig", + "description": "Optional. Config for audio transcription (speech recognition)." + }, "candidateCount": { "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", @@ -63318,7 +68377,8 @@ }, "imageConfig": { "$ref": "GoogleCloudAiplatformV1beta1ImageConfig", - "description": "Optional. Config for image generation features." + "deprecated": true, + "description": "Optional. Config for image generation features. Deprecated: Use `response_format.image` instead." }, "logprobs": { "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.", @@ -63356,8 +68416,16 @@ "format": "float", "type": "number" }, + "responseFormat": { + "description": "Optional. New response format field for the model to configure output formatting and delivery.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ResponseFormat" + }, + "type": "array" + }, "responseJsonSchema": { - "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`.", + "deprecated": true, + "description": "Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead.", "type": "any" }, "responseLogprobs": { @@ -63365,7 +68433,8 @@ "type": "boolean" }, "responseMimeType": { - "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.", + "deprecated": true, + "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. Deprecated: Use `response_format` instead.", "type": "string" }, "responseModalities": { @@ -63391,7 +68460,8 @@ }, "responseSchema": { "$ref": "GoogleCloudAiplatformV1beta1Schema", - "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`." + "deprecated": true, + "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`. Deprecated: Use `response_format` instead." }, "routingConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", @@ -63623,12 +68693,44 @@ "id": "GoogleCloudAiplatformV1beta1GoogleMaps", "properties": { "enableWidget": { - "description": "Optional. If true, include the widget context token in the response.", + "deprecated": true, + "description": "Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response.", "type": "boolean" + }, + "groundingTypes": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", + "description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes": { + "description": "Defines the types of Google Maps grounding that can be enabled and their configurations.", + "id": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", + "properties": { + "places": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", + "description": "Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified." + }, + "routing": { + "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", + "description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GoogleMapsPlaces": { + "description": "Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified.", + "id": "GoogleCloudAiplatformV1beta1GoogleMapsPlaces", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GoogleMapsRouting": { + "description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", + "id": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", @@ -63890,7 +68992,8 @@ "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { "googleMapsWidgetContextToken": { - "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.", + "deprecated": true, + "description": "Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. 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" }, @@ -64208,6 +69311,95 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ImageResponseFormat": { + "description": "Configuration for image-specific output formatting.", + "id": "GoogleCloudAiplatformV1beta1ImageResponseFormat", + "properties": { + "aspectRatio": { + "description": "Optional. The aspect ratio for the image output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_ONE_BY_ONE", + "ASPECT_RATIO_TWO_BY_THREE", + "ASPECT_RATIO_THREE_BY_TWO", + "ASPECT_RATIO_THREE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_THREE", + "ASPECT_RATIO_FOUR_BY_FIVE", + "ASPECT_RATIO_FIVE_BY_FOUR", + "ASPECT_RATIO_NINE_BY_SIXTEEN", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_TWENTY_ONE_BY_NINE", + "ASPECT_RATIO_ONE_BY_EIGHT", + "ASPECT_RATIO_EIGHT_BY_ONE", + "ASPECT_RATIO_ONE_BY_FOUR", + "ASPECT_RATIO_FOUR_BY_ONE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "1:1 aspect ratio.", + "2:3 aspect ratio.", + "3:2 aspect ratio.", + "3:4 aspect ratio.", + "4:3 aspect ratio.", + "4:5 aspect ratio.", + "5:4 aspect ratio.", + "9:16 aspect ratio.", + "16:9 aspect ratio.", + "21:9 aspect ratio.", + "1:8 aspect ratio.", + "8:1 aspect ratio.", + "1:4 aspect ratio.", + "4:1 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "imageSize": { + "description": "Optional. The size of the image output.", + "enum": [ + "IMAGE_SIZE_UNSPECIFIED", + "IMAGE_SIZE_FIVE_TWELVE", + "IMAGE_SIZE_ONE_K", + "IMAGE_SIZE_TWO_K", + "IMAGE_SIZE_FOUR_K" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "512px image size.", + "1K image size.", + "2K image size.", + "4K image size." + ], + "type": "string" + }, + "mimeType": { + "description": "Optional. The MIME type of the image output.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "IMAGE_JPEG" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JPEG image format." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ImportDataConfig": { "description": "Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations.", "id": "GoogleCloudAiplatformV1beta1ImportDataConfig", @@ -64268,6 +69460,150 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest": { + "description": "Request message for EvaluationManagementService.ImportEvaluationSet.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequest", + "properties": { + "agentEngineSource": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource", + "description": "Source for loading Agent Engine sessions." + }, + "bigquerySource": { + "$ref": "GoogleCloudAiplatformV1beta1BigQueryRequestSet", + "description": "BigQuery source with column mappings." + }, + "cloudTraceSource": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource", + "description": "Source for loading data directly from Cloud Trace." + }, + "evaluationSet": { + "$ref": "GoogleCloudAiplatformV1beta1EvaluationSet", + "description": "Required. The EvaluationSet to create. Used to specify 'display_name' and 'metadata'. The 'evaluation_items' field is ignored and populated by the import process." + }, + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Required. The Cloud Storage location where the resulting EvaluationItem payloads will be stored." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource", + "description": "Google Cloud Storage location." + }, + "inlineSource": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource", + "description": "Inline source for small payloads (< 4MB)." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource": { + "description": "Source for loading Agent Engine sessions.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestAgentEngineSource", + "properties": { + "location": { + "description": "Required. Location for the Agent Engine sessions.", + "type": "string" + }, + "projectId": { + "description": "Required. Project ID for the Agent Engine sessions.", + "type": "string" + }, + "reasoningEngineId": { + "description": "Required. Reasoning Engine ID for the Agent Engine sessions.", + "type": "string" + }, + "sessionIds": { + "description": "Required. Session IDs for the Agent Engine sessions to retrieve.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource": { + "description": "Source for loading traces directly from Cloud Trace.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestCloudTraceSource", + "properties": { + "projectId": { + "description": "Required. Project ID for the Cloud Trace.", + "type": "string" + }, + "sessionIds": { + "description": "Optional. Session IDs to import traces for. If both trace_ids and session_ids are specified, the union of the two will be imported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "traceIds": { + "description": "Optional. Trace IDs to import.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource": { + "description": "Source for loading data from Cloud Storage.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestGcsSource", + "properties": { + "gcsUri": { + "description": "Required. The Cloud Storage location of the input data.", + "type": "string" + }, + "importSchemaConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig", + "description": "Required. Schema configuration for the input data." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig": { + "description": "Configuration for the input data format.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig", + "properties": { + "dataFormat": { + "description": "Required. The format of the input data.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "OTEL_PROTO", + "OTEL_JSON", + "JSONL" + ], + "enumDescriptions": [ + "Unspecified data format.", + "OpenTelemetry Protobuf format (e.g. TracesData).", + "OpenTelemetry JSON format.", + "JSONL format mapping directly to EvaluationItem schema." + ], + "type": "string" + }, + "dataFormatVersion": { + "description": "Optional. Version of the data format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource": { + "description": "Wrapper for inline data.", + "id": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestInlineSource", + "properties": { + "content": { + "description": "Required. The content of the inline data.", + "format": "byte", + "type": "string" + }, + "importSchemaConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ImportEvaluationSetRequestImportSchemaConfig", + "description": "Required. Schema configuration for the inline data." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ImportExtensionOperationMetadata": { "description": "Details of ExtensionRegistryService.ImportExtension operation.", "id": "GoogleCloudAiplatformV1beta1ImportExtensionOperationMetadata", @@ -65033,6 +70369,27 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig": { + "description": "Configures emission of the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log.", + "id": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", + "properties": { + "state": { + "description": "Optional. Whether the `aiplatform.googleapis.com/inference_request` log is enabled.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "Not specified. Treated as `DISABLED`.", + "Inference-event logging is enabled.", + "Inference-event logging is disabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1IngestEventsRequest": { "description": "Request message for MemoryBankService.IngestEvents.", "id": "GoogleCloudAiplatformV1beta1IngestEventsRequest", @@ -65041,6 +70398,10 @@ "$ref": "GoogleCloudAiplatformV1beta1IngestionDirectContentsSource", "description": "Ingest events directly from the request." }, + "disableMemoryRevisions": { + "description": "Optional. If true, no revisions will be created for this request.", + "type": "boolean" + }, "forceFlush": { "description": "Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`.", "type": "boolean" @@ -65049,6 +70410,46 @@ "$ref": "GoogleCloudAiplatformV1beta1MemoryGenerationTriggerConfig", "description": "Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately." }, + "metadata": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1MemoryMetadataValue" + }, + "description": "Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank.", + "type": "object" + }, + "metadataMergeStrategy": { + "description": "Optional. The strategy to use when applying metadata to existing memories.", + "enum": [ + "METADATA_MERGE_STRATEGY_UNSPECIFIED", + "OVERWRITE", + "MERGE", + "REQUIRE_EXACT_MATCH" + ], + "enumDescriptions": [ + "Unspecified metadata merge strategy. If unspecified, the default behavior is to overwrite existing metadata (`OVERWRITE`).", + "Replace the metadata of the updated memories with the new metadata.", + "Append new metadata to the existing metadata. If there are duplicate keys, the existing values will be overwritten.", + "Restrict consolidation to memories that have exactly the same metadata as the request. If a memory doesn't have the same metadata, it is not eligible for consolidation." + ], + "type": "string" + }, + "revisionExpireTime": { + "description": "Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted.", + "format": "google-datetime", + "type": "string" + }, + "revisionLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source.", + "type": "object" + }, + "revisionTtl": { + "description": "Optional. The TTL for the revision. The expiration time is computed: now + TTL.", + "format": "google-duration", + "type": "string" + }, "scope": { "additionalProperties": { "type": "string" @@ -65443,15 +70844,22 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse": { - "description": "Response message for AgentEngineTaskStoreService.ListA2aTaskEvents.", + "description": "Response message for ListA2aTaskEvents.", "id": "GoogleCloudAiplatformV1beta1ListA2aTaskEventsResponse", "properties": { + "events": { + "description": "List of A2aTaskEvents in the requested page. Populated only by the TaskStoreService.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1A2aTaskEvent" + }, + "type": "array" + }, "nextPageToken": { "description": "A token to retrieve the next page of results.", "type": "string" }, "taskEvents": { - "description": "List of TaskEvents in the requested page.", + "description": "List of TaskEvents in the requested page. Populated only by the AgentEngineTaskStoreService.", "items": { "$ref": "GoogleCloudAiplatformV1beta1TaskEvent" }, @@ -65461,7 +70869,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ListA2aTasksResponse": { - "description": "Response message for AgentEngineTaskStoreService.ListA2aTasks.", + "description": "Response message for ListA2aTasks.", "id": "GoogleCloudAiplatformV1beta1ListA2aTasksResponse", "properties": { "a2aTasks": { @@ -65478,24 +70886,118 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse": { + "description": "Response message for AgentAnomalyDetectionService.ListAgentAnomalyDetectionScopes.", + "id": "GoogleCloudAiplatformV1beta1ListAgentAnomalyDetectionScopesResponse", + "properties": { + "agentAnomalyDetectionScopes": { + "description": "A list of AgentAnomalyDetectionScopes that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListAgentsResponse": { "description": "Response message for AgentService.ListAgents.", "id": "GoogleCloudAiplatformV1beta1ListAgentsResponse", "properties": { "agents": { - "description": "A list of agents matching the request.", + "description": "The agents matching the request.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "type": "array" }, "nextPageToken": { - "description": "A token, which can be sent as ListAgentsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "description": "A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call.", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse": { + "description": "Response to list analyzed invocations.", + "id": "GoogleCloudAiplatformV1beta1ListAnalyzedInvocationsResponse", + "properties": { + "analyzedInvocations": { + "description": "The list of analyzed invocations.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedInvocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse": { + "description": "Response to list analyzed sessions.", + "id": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponse", + "properties": { + "analyzedSessions": { + "description": "The list of analyzed sessions.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSession" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.", + "type": "string" + }, + "summary": { + "$ref": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary", + "description": "Summary statistics computed across the sessions on the current page only. For statistics across the entire result set, use AggregateAnalyzedSessions." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary": { + "description": "The view summary.", + "id": "GoogleCloudAiplatformV1beta1ListAnalyzedSessionsResponseViewSummary", + "properties": { + "anomalousAgentsCount": { + "description": "Output only. The number of distinct agents in the request scope with at least one anomalous session in the time window. On `AggregateAnalyzedSessionsResponse.summary` this is a global count; it is not populated on `ListAnalyzedSessionsResponse.summary`.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "anomalousSessionsCount": { + "description": "Number of anomalous sessions.", + "format": "int32", + "type": "integer" + }, + "llmScannedSessionsCount": { + "description": "Output only. The number of distinct sessions in the time window that were scanned by the LLM judge.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "severities": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" + }, + "description": "The list of severity summaries for the analyzed sessions. The key is the string representation of Severity enum: \"SEVERITY_UNSPECIFIED\", \"SEVERITY_CRITICAL\", \"SEVERITY_HIGH\", \"SEVERITY_MEDIUM\", \"SEVERITY_LOW\".", + "type": "object" + }, + "totalSessionsCount": { + "description": "Total number of sessions.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListAnnotationsResponse": { "description": "Response message for DatasetService.ListAnnotations.", "id": "GoogleCloudAiplatformV1beta1ListAnnotationsResponse", @@ -66018,6 +71520,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse": { + "description": "Response message for ListFeedbackEntries.", + "id": "GoogleCloudAiplatformV1beta1ListFeedbackEntriesResponse", + "properties": { + "feedbackEntries": { + "description": "The page of FeedbackEntries matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeedbackEntry" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page. Absence of this field indicates there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse": { "description": "Response message for JobService.ListHyperparameterTuningJobs", "id": "GoogleCloudAiplatformV1beta1ListHyperparameterTuningJobsResponse", @@ -66288,6 +71808,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse": { + "description": "Response message for AgentAnomalyDetectionService.ListMonitoredAgents.", + "id": "GoogleCloudAiplatformV1beta1ListMonitoredAgentsResponse", + "properties": { + "monitoredAgents": { + "description": "A list of MonitoredAgents that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1MonitoredAgent" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "totalSize": { + "description": "The total number of MonitoredAgents matching the request, after any `filter` is applied.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListNasJobsResponse": { "description": "Response message for JobService.ListNasJobs", "id": "GoogleCloudAiplatformV1beta1ListNasJobsResponse", @@ -66667,6 +72210,44 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse": { + "description": "Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies.", + "id": "GoogleCloudAiplatformV1beta1ListSemanticGovernancePoliciesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page.", + "type": "string" + }, + "semanticGovernancePolicies": { + "description": "The list of SemanticGovernancePolicies.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListServingProfilesResponse": { + "description": "Response message for ServingProfileService.ListServingProfiles.", + "id": "GoogleCloudAiplatformV1beta1ListServingProfilesResponse", + "properties": { + "nextPageToken": { + "description": "Output only. A token to retrieve the next page of results.", + "readOnly": true, + "type": "string" + }, + "servingProfiles": { + "description": "Output only. A list of ServingProfiles.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfile" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListSessionsResponse": { "description": "Response message for SessionService.ListSessions.", "id": "GoogleCloudAiplatformV1beta1ListSessionsResponse", @@ -67084,7 +72665,7 @@ "id": "GoogleCloudAiplatformV1beta1MachineSpec", "properties": { "acceleratorCount": { - "description": "The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.", + "description": "The number of accelerators to attach to the machine. For [accelerator optimized machine types](https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Agent Platform co-schedules the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Agent Platform co-schedules 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled.", "format": "int32", "type": "integer" }, @@ -67160,7 +72741,7 @@ "type": "string" }, "machineType": { - "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", + "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" }, "minGpuDriverVersion": { @@ -67591,6 +73172,11 @@ "description": "Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity.", "format": "google-duration", "type": "string" + }, + "overlapEventCount": { + "description": "Optional. Re-include the last N already-processed events in the next window.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -68480,7 +74066,7 @@ }, "containerSpec": { "$ref": "GoogleCloudAiplatformV1beta1ModelContainerSpec", - "description": "Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." + "description": "The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models." }, "createTime": { "description": "Output only. Timestamp when this Model was uploaded into Vertex AI.", @@ -70427,6 +76013,59 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1MonitoredAgent": { + "description": "Represents a monitored agent in a specific Location.", + "id": "GoogleCloudAiplatformV1beta1MonitoredAgent", + "properties": { + "agentResource": { + "$ref": "GoogleCloudAiplatformV1beta1AgentResource", + "description": "Required. The configuration for the agent being monitored." + }, + "createTime": { + "description": "Output only. The time the MonitoredAgent was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. The display name of the MonitoredAgent.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the MonitoredAgent.", + "type": "string" + }, + "state": { + "description": "Output only. The current state of the agent's enablement.", + "enum": [ + "ENABLEMENT_STATE_UNSPECIFIED", + "ACTIVE", + "ENABLING", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The agent is successfully enabled and active.", + "The agent is in the process of being enabled.", + "The agent is disabled." + ], + "readOnly": true, + "type": "string" + }, + "statusMessage": { + "description": "Output only. A brief message explaining the current state.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the MonitoredAgent was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", @@ -71088,7 +76727,8 @@ "INVALID_SPARSE_EMBEDDING", "INVALID_EMBEDDING", "INVALID_EMBEDDING_METADATA", - "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT" + "EMBEDDING_METADATA_EXCEEDS_SIZE_LIMIT", + "DUPLICATE_ID" ], "enumDescriptions": [ "Default, shall not be used.", @@ -71110,7 +76750,8 @@ "Invalid sparse embedding.", "Invalid dense embedding.", "Invalid embedding metadata.", - "Embedding metadata exceeds size limit." + "Embedding metadata exceeds size limit.", + "Multiple input records share the same datapoint id. The input conversion pipeline performs non-deterministic last-write-wins de-duplication and emits one error per duplicated id." ], "type": "string" }, @@ -71372,6 +77013,29 @@ "persistentDiskSpec": { "$ref": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "description": "The specification of a persistent disk to attach for the execution job." + }, + "shieldedInstanceConfig": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", + "description": "Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig": { + "description": "A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm.", + "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Optional. Whether the VM instance has integrity monitoring enabled.", + "type": "boolean" + }, + "enableSecureBoot": { + "description": "Optional. Whether the VM instance has Secure Boot enabled. Disabled by default.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Optional. Whether the VM instance has vTPM enabled.", + "type": "boolean" } }, "type": "object" @@ -71421,7 +77085,50 @@ "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime": { "description": "Configuration for a Workbench Instances-based environment.", "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntime", - "properties": {}, + "properties": { + "customContainerImage": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage", + "description": "A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM." + }, + "vmImage": { + "$ref": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", + "description": "A specific Compute Engine VM image to run the notebook on." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage": { + "description": "The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`.", + "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeContainerImage", + "properties": { + "repository": { + "description": "Required. The path to the container image repository. For example: `gcr.io/{project_id}/{image_name}`.", + "type": "string" + }, + "tag": { + "description": "Optional. The tag of the container image. If unset, defaults to `latest`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage": { + "description": "The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`.", + "id": "GoogleCloudAiplatformV1beta1NotebookExecutionJobWorkbenchRuntimeVmImage", + "properties": { + "family": { + "description": "Use this VM image family to find the image; the newest image in this family is used.", + "type": "string" + }, + "name": { + "description": "Use this VM image name to find the image.", + "type": "string" + }, + "project": { + "description": "Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id}`.", + "type": "string" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1NotebookIdleShutdownConfig": { @@ -71818,7 +77525,7 @@ }, "cloudObservability": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability", - "description": "Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging)." + "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging)." }, "config": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorConfig", @@ -71831,7 +77538,7 @@ "type": "string" }, "displayName": { - "description": "Optional. Human-readable name for the `OnlineEvaluator`. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", + "description": "Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned.", "type": "string" }, "metricSources": { @@ -71882,7 +77589,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability": { - "description": "Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).", + "description": "Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging).", "id": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservability", "properties": { "logView": { @@ -71969,7 +77676,7 @@ "properties": { "duration": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", - "description": "Filter on the duration of a trace." + "description": "Filter on the duration of a trace (in seconds)." }, "totalTokenUsage": { "$ref": "GoogleCloudAiplatformV1beta1OnlineEvaluatorCloudObservabilityNumericPredicate", @@ -72441,6 +78148,10 @@ "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": { + "audioTranscription": { + "$ref": "GoogleCloudAiplatformV1beta1AudioTranscription", + "description": "Optional. Audio (input or output) transcription. This is only set when this Part contains audio data." + }, "codeExecutionResult": { "$ref": "GoogleCloudAiplatformV1beta1CodeExecutionResult", "description": "Optional. The result of executing the ExecutableCode." @@ -72580,6 +78291,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentService.PauseSandboxEnvironment.", + "id": "GoogleCloudAiplatformV1beta1PauseSandboxEnvironmentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PauseScheduleRequest": { "description": "Request message for ScheduleService.PauseSchedule.", "id": "GoogleCloudAiplatformV1beta1PauseScheduleRequest", @@ -72587,7 +78304,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1PersistentDiskSpec": { - "description": "Represents the spec of persistent disk options.", + "description": "Represents the spec of persistent disk and hyperdisk options.", "id": "GoogleCloudAiplatformV1beta1PersistentDiskSpec", "properties": { "diskSizeGb": { @@ -72596,7 +78313,7 @@ "type": "string" }, "diskType": { - "description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk)", + "description": "Type of the disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) \"pd-standard\" (Persistent Disk Hard Disk Drive) \"pd-balanced\" (Balanced Persistent Disk) \"pd-extreme\" (Extreme Persistent Disk) \"hyperdisk-balanced\" (Hyperdisk Balanced) \"hyperdisk-extreme\" (Hyperdisk Extreme) \"hyperdisk-balanced-high-availability\" (Hyperdisk Balanced High Availability) \"hyperdisk-ml\" (Hyperdisk ML) \"hyperdisk-throughput\" (Hyperdisk Throughput)", "type": "string" } }, @@ -74030,6 +79747,54 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ProcessDataRequest": { + "description": "Request message for GenAiTuningService.ProcessData.", + "id": "GoogleCloudAiplatformV1beta1ProcessDataRequest", + "properties": { + "gcsDestination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Optional. The GCS bucket to store the processed videos and captions data." + }, + "gcsSource": { + "$ref": "GoogleCloudAiplatformV1beta1GcsSource", + "description": "Optional. A JSONL file containing a list of files to process stored in the user's GCS bucket." + }, + "inputBucketProjectNumber": { + "description": "Optional. The project number of the project that the user expects to own the input Cloud Storage bucket referenced by gcs_source. The service verifies that the bucket is actually owned by this project before reading from it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", + "format": "int64", + "type": "string" + }, + "outputBucketProjectNumber": { + "description": "Optional. The project number of the project that the user expects to own the output Cloud Storage bucket referenced by gcs_destination. The service verifies that the bucket is actually owned by this project before writing to it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent).", + "format": "int64", + "type": "string" + }, + "veoSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", + "description": "Optional. Spec for Veo data processing." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec": { + "description": "Spec for Veo data processing.", + "id": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", + "properties": { + "processType": { + "description": "Optional. The type of data processing to perform.", + "enum": [ + "VEO_V1_AND_V2_DEFAULT", + "VEO_V3" + ], + "enumDescriptions": [ + "Process type for Veo 1 and 2.", + "Process type for Veo 3." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints": { "description": "PscAutomatedEndpoints defines the output of the forwarding rule automatically created by each PscAutomationConfig.", "id": "GoogleCloudAiplatformV1beta1PscAutomatedEndpoints", @@ -74408,9 +80173,45 @@ "description": "This message contains configs of a publisher model.", "id": "GoogleCloudAiplatformV1beta1PublisherModelConfig", "properties": { + "claudeFeatureConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig", + "description": "Optional. Config for Claude-specific features." + }, + "dataSharingEnabledProvider": { + "description": "Optional. The model provider (publisher) for which the customer has enabled data sharing. For publisher models that are configured to require data sharing, a prediction request is only allowed when the model's publisher matches this provider. Otherwise, the request is rejected.", + "enum": [ + "MODEL_PROVIDER_UNSPECIFIED", + "ANTHROPIC" + ], + "enumDescriptions": [ + "Unspecified model provider.", + "Anthropic." + ], + "type": "string" + }, + "inferenceEventLoggingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1InferenceEventLoggingConfig", + "description": "Optional. Turns the per-request `aiplatform.googleapis.com/inference_request` Cloud Logging log on or off. The log records structured per-request metadata (such as principal, traffic type, and token usage). When enabled, logs are emitted for all publisher-model traffic on the model -- Provisioned Throughput and on-demand alike. This is distinct from `logging_config` above: that one logs raw request/response payloads to a BigQuery table, while this one controls structured per-request metadata in Cloud Logging." + }, "loggingConfig": { "$ref": "GoogleCloudAiplatformV1beta1PredictRequestResponseLoggingConfig", - "description": "The prediction request/response logging config." + "description": "Optional. The prediction request/response logging config." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig": { + "description": "Config for Claude-specific features.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelConfigClaudeFeatureConfig", + "properties": { + "advancedAiEnabled": { + "description": "Optional. Indicates whether the customer has enabled advanced AI features for this publisher model (data retention opt-in). See b/528731813. This is the source of truth; the deprecated `cyber_verification_program_enabled` is no longer consulted on read.", + "type": "boolean" + }, + "cyberVerificationProgramEnabled": { + "deprecated": true, + "description": "Optional. Deprecated: use `advanced_ai_enabled` instead. Indicates whether the customer has enabled the Cyber Verification Program (CVP) for this publisher model (data retention opt-in). See b/528731813.", + "type": "boolean" } }, "type": "object" @@ -76639,6 +82440,10 @@ "description": "Optional. The OSS agent framework used to develop the agent. Currently supported values: \"google-adk\", \"langchain\", \"langgraph\", \"ag2\", \"llama-index\", \"custom\".", "type": "string" }, + "buildSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", + "description": "Optional. Configuration for building container image." + }, "classMethods": { "description": "Optional. Declarations for object class methods in OpenAPI specification format.", "items": { @@ -76692,6 +82497,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec": { + "description": "Specification for building container image.", + "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", + "properties": { + "serviceAccount": { + "description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", + "type": "string" + }, + "workerPool": { + "description": "Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec": { "description": "Specification for deploying from a container image.", "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecContainerSpec", @@ -76699,6 +82519,11 @@ "imageUri": { "description": "Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica.", "type": "string" + }, + "port": { + "description": "Optional. The port the container listens on. Defaults to 8080 if unset.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -77158,6 +82983,350 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer": { + "description": "ReinforcementTuningAutoraterScorer is used to score parsed responses for classification based autorater use cases. For example, for math problems, users can use classification based autorater to calculate rewards based on the autorater parsed response against a reference answer.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer", + "properties": { + "autoraterConfig": { + "$ref": "GoogleCloudAiplatformV1beta1AutoraterConfig", + "description": "Autorater config for classification based autorater" + }, + "autoraterPrompt": { + "description": "The prompt for an autorater to scorer the parsed sample response. This field supports the following placeholders that will be replaced before scoring: - {{prompt}} - {{response}} - {{system_instruction}} - {{references.key}} ", + "type": "string" + }, + "autoraterResponseParseConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig", + "description": "Parses autorater returned response for scoring. For example, if the autorater response has reward stored in the `2.0` block, defining a parsing response config using regex `\".*(.*?)\"` will return a score `\"2.0\"`." + }, + "exactMatchScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer", + "description": "Scores autorater responses by using string match reward scorer." + }, + "parsedResponseConversionScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer", + "description": "Scores autorater responses by directly converting parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer": { + "description": "Scores autorater responses by using exact string match reward scorer.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerExactMatchScorer", + "properties": { + "correctAnswerReward": { + "description": "Assigns this reward score if the parsed response string equals the expression.", + "format": "float", + "type": "number" + }, + "expression": { + "description": "The string expression to match against for scoring. This field supports placeholders in the format of {{references.key}} that will be replaced before matching. Regex is not supported for this expression. For example, users can define an ExactMatchScorer as follows: { \"correctAnswerReward\": 1.0, \"wrongAnswerReward\": -1.0, \"expression\": \"{{references.concise_answer}}\" } When evaluating the reward for each parsed autorater response, if the prompt references in the training/validation dataset has the following fields: ``` { \"example\": ..., \"references\": { \"concise_ansser\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } } ``` The above ExactMatchScorer will be replaced as follows for scoring: ``` { \"correctAnswerReward\": 1.0, \"wrongAnswerReward\": -1.0, \"expression\": \"Yes\" } ``` If the *parsed* autorater response is equal to the string `\"Yes\"`, then the reward is `1.0`, otherwise the reward is `-1.0`.", + "type": "string" + }, + "wrongAnswerReward": { + "description": "Assigns this reward score if the parsed reward value does not equal the expression.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer": { + "description": "Scores responses by directly converting the parsed autorater response to a float reward. Note: Reward is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorerParsedResponseConversionScorer", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer": { + "description": "ReinforcementTuningCloudRunRewardScorer allows users to implement a reward function through GCP Cloud Run. Comparing with ReinforcementTuningCodeExecutionRewardScorer that runs in a Sandbox and has no internet access, Cloud Run reward scorer is fully controlled by users. The Cloud Run service should implement the following HTTP API: HTTP method: `POST` HTTP request body: ``` { \"example\": ReinforcementTuningExample, \"response\": Content, \"metadata\": { \"step\": int \"tuning_job_id\": int64 } } ``` * `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get(\"systemInstruction\")`) and references (i.e., `example.get(\"references\")`) are also included in the `example` provided that they are set in the training/validation dataset. * `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. HTTP response body: { \"reward\": float, \"user_requested_aux_info\": str // Optional } where the field \"user_requested_aux_info\" is any (optional) string provided by users for assisting debugging. It's in snake case. This field is mostly useful when calling the GenAiTuningService.ValidateReinforcementTuningReward API, where the proto field (not Cloud Run HTTP response body) userRequestedAuxInfo will be populated if the Cloud Run reward function sets this field in the HTTP response. The following are examples for the HTTP request and response body. Example HTTP request body: ``` { \"example\": { \"contents\": [ { \"role\": \"user\", \"parts\": [ { \"text\": \"What is the capital of France?\" } ] } ], \"references\": { \"answer\": \"Paris\" } }, \"response\": { \"parts\": [ { \"text\": \"London\" } ] }, \"metadata\": { \"step\": 1, \"tuning_job_id\": 123456789 } } ``` Example HTTP response body: ``` { \"reward\": -1.0 } ``` Note: Reward output by Cloud Run reward function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer", + "properties": { + "cloudRunUri": { + "description": "URI of the Cloud Run service that will be used to compute the reward. The [Vertex AI Secure Fine Tuning Service Agent](https://docs.cloud.google.com/iam/docs/service-agents#vertex-ai-secure-fine-tuning-service-agent) (`service-@gcp-sa-vertex-tune.iam.gserviceaccount.com`) must be granted the permission (e.g. by granting `roles/run.invoker` in IAM) to invoke the Cloud Run service.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer": { + "description": "ReinforcementTuningCodeExecutionRewardScorer allows users to implement a function to evaluate rewards for the sample response. The function signature is as follows: ``` def evaluate(example: dict[str, Any], response: dict[str, Any]) -> float: ... ``` `example` is a ReinforcementTuningExample in ProtoJSON format, (i.e., the format is the same as as one line in the training/validation dataset except that the keys must be in camel case). System instructions (i.e., `example.get(\"systemInstruction\")`) and references (i.e., `example.get(\"references\")`) are also included in the `example` provided that they are set in the training/validation dataset. `response` is a Content in ProtoJSON format (i.e., keys must be in camel case), which is the same as the Online Prediction response for Gemini models. Note: Reward output by the `evaluate` function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer", + "properties": { + "pythonCodeSnippet": { + "description": "The python code snippet as a string for evaluating rewards. The following is an example python code snippet that returns a reward `1.0` for a parsed response matching the user-provided reference answer in per prompt references map. ``` def evaluate(example, response) -> float: response_str = response.get(\"parts\", [])0 references = example.get(\"references\", {}) if response_str == references.get(\"concise_answer\"): return 1.0 return -1.0 ``` Note: Reward output by the evaluate function is clipped to be within `[-1, 1]`, i.e., `reward = max(min(reward, 1.0), -1.0)`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningExample": { + "description": "User-facing format for Gemini Reinforcement Tuning examples on Vertex.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample", + "properties": { + "contents": { + "description": "Multi-turn contents that represents the Prompt.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "references": { + "additionalProperties": { + "type": "string" + }, + "description": "References for the given prompt. The key is the name of the reference, and the value is the reference itself. Users can use this field together with the reward configurations to calculate rewards for reinforcement tuning. For example, users can set the following references: ``` { \"concise_answer\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } ``` Then in a ReinforcementTuningCodeExecutionRewardScorer reward function config, for example, they can define a python code snippet as follows: ``` def evaluate(example, response) -> float: response_str = response.get(\"parts\", [])0 references = example.get(\"references\", {}) if response_str == references.get(\"concise_answer\"): return 1.0 return -1.0 ``` In this case, references can serve the purpose of holding the ground truth of this example in the training/validation dataset.", + "type": "object" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Corresponds to system_instruction in user-facing GenerateContentRequest." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters": { + "description": "Hyperparameters for Reinforcement Tuning.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters", + "properties": { + "adapterSize": { + "description": "Optional. Adapter size for Reinforcement Tuning.", + "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" + }, + "batchSize": { + "description": "Optional. Batch size for the tuning job. How many prompts to process at a train step. If not set, the batch size will be determined automatically.", + "format": "int32", + "type": "integer" + }, + "checkpointInterval": { + "description": "Optional. How often at steps to save checkpoints during training. If not set, one checkpoint per epoch will be set. ```total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset```", + "format": "int32", + "type": "integer" + }, + "epochCount": { + "description": "Optional. Number of training epoches for the tuning job.", + "format": "int64", + "type": "string" + }, + "evaluateInterval": { + "description": "Optional. How often at steps to evaluate the tuning job during training. If not set, evel will be run per epoch. `total_steps = epoch_count * samples_per_prompt / total_prompts_in_dataset`", + "format": "int32", + "type": "integer" + }, + "learningRateMultiplier": { + "description": "Optional. Learning rate multiplier for Reinforcement Tuning.", + "format": "double", + "type": "number" + }, + "maxOutputTokens": { + "description": "Optional. The maximum number of tokens to generate per prompt. Default to 32768.", + "format": "int32", + "type": "integer" + }, + "samplesPerPrompt": { + "description": "Optional. Number of different responses to generate per prompt during tuning.", + "format": "int32", + "type": "integer" + }, + "stepCount": { + "description": "Optional. Number of steps for the tuning job (mutually exclusive with epoch_count).", + "format": "int64", + "type": "string" + }, + "thinkingBudget": { + "description": "Optional. The thinking budget for the tuning job to optimize for (Gemini 2.5 only). * -1 means dynamic thinking * 0 means no thinking * > 0 means thinking budget in tokens If not set, default to -1 (dynamic thinking).", + "format": "int32", + "type": "integer" + }, + "thinkingLevel": { + "description": "Indicates the maximum thinking depth during tuning. Starting from Gemini 3.5 models, the old thinking_budget will no longer be supported and will result in a user error if set. Instead, users should use the thinking_level parameter to control the maximum thinking depth.", + "enum": [ + "REINFORCEMENT_TUNING_THINKING_LEVEL_UNSPECIFIED", + "MINIMAL", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Unspecified thinking level.", + "Little to no thinking.", + "Low thinking level.", + "Medium thinking level.", + "High thinking level." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig": { + "description": "Defines how to parse sample response config for reinforcement tuning. The parsed response (i.e., substring) will be passed to the reward functions. For example, the input prompt might be: > \"Perform step-by-step thoughts first to problem A, finally output answer in the block.\" The sample response from the model under tuning might look like: > \"Yes\" Here, users can define the following parse config: ``` { \"parseType\": \"REGEX_EXTRACT\", \"regexExtractExpression\": \".*(.*?)\" } ``` The resulting parsed response would be `\"Yes\"` and will be passed to the reward functions for evaluating rewards.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig", + "properties": { + "parseType": { + "description": "Defines the type for parsing sample response.", + "enum": [ + "RESPONSE_PARSE_TYPE_UNSPECIFIED", + "IDENTITY", + "REGEX_EXTRACT" + ], + "enumDescriptions": [ + "Default value. Fallback to IDENTITY", + "Returns the sample response as is.", + "Uses regex to extract the important part of sample response. Similar to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_extract) `REGEX_EXTRACT(response, regex_extract_expression)`, but different in that if there are multiple matches, the last match will be returned." + ], + "type": "string" + }, + "regexExtractExpression": { + "description": "Defines the regex for extracting the important part of sample response. This field is only used when parse_type is ResponseParseType.REGEX_EXTRACT.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo": { + "description": "The reward info for a reward function.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo", + "properties": { + "reward": { + "description": "Output only. The calculated reward for the reward function.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "userRequestedAuxInfo": { + "description": "Output only. The user-requested auxiliary info for the reward function. This field is set only if the Cloud Run reward function configured by user returns a \"user_requested_aux_info\". Refer to ReinforcementTuningCloudRunRewardScorer for more details.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec": { + "description": "Tuning spec for Reinforcement Tuning.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec", + "properties": { + "compositeRewardConfig": { + "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig", + "description": "Composite reward function configuration for reinforcement tuning." + }, + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningHyperParameters", + "description": "Optional. Hyper-parameters for reinforcement tuning." + }, + "singleRewardConfig": { + "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", + "description": "Single Reward function configuration for reinforcement tuning." + }, + "trainingDatasetUri": { + "description": "Cloud Storage path to the file containing training dataset for tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + }, + "validationDatasetUri": { + "description": "Cloud Storage path to the file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer": { + "description": "ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for string matching use cases. For example, for math problems, users can use string match scorer to check if the correct exact answer is generated. Note: Reward returned by the string match reward function is clipped to be within `[-1, 1]` if wrongAnswerReward or correctAnswerReward are beyond the range, i.e., `reward = max(min(reward, 1.0), -1.0)`.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer", + "properties": { + "correctAnswerReward": { + "description": "Correct answer rewawrd is returned if the parsed response is evaluated as `true`. All correct answers get the same reward.", + "format": "float", + "type": "number" + }, + "jsonMatchExpression": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression", + "description": "Uses json match expression to evaluate parsed response." + }, + "stringMatchExpression": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression", + "description": "Uses string match expression to evaluate parsed response." + }, + "wrongAnswerReward": { + "description": "Wrong answer reward is returned if the parsed response is evaluated as `false`. All wrong answers get the same reward.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression": { + "description": "JsonMatchExpression supports converting the parsed responses to JSON format, finding the value in the JSON response that matches the key_name in the first level, and performing StringMatchExpression operation on the matched JSON value.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerJsonMatchExpression", + "properties": { + "keyName": { + "description": "The key name to find the value in the parsed response that's in JSON format. Only first-level key matching is supported.", + "type": "string" + }, + "valueStringMatchExpression": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression", + "description": "String match expression to match against the extracted value from the JSON representation of the parsed response." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression": { + "description": "Evaluates parsed response using match type against the expression. Returns `true` if `MatchOperation(target, expression)` evaluates to `true`, and `false` otherwise.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorerStringMatchExpression", + "properties": { + "expression": { + "description": "A string or a regular expression to match against for evaluating rewards. Users can also provide a references map of `{key: value}` whose `value` will be used to replace the placeholder {{references.key}} in the expression. For example, if the following `references` are defined in the training / validation dataset: ``` { \"systemInstruction\": ..., \"contents\": ..., \"references\": { \"concise_answer\": \"Yes\", \"verbose_answer\": \"The answer is Yes\" } } ``` and if users define the following StringMatchExpression: { \"matchOperation\": \"REGEX_CONTAINS\", \"expression\": \".*{{references.concise_answer}}.*\" } On evaluating the reward for each sample response, this StringMatchExpression will be substituted as: ``` { \"matchOperation\": \"REGEX_CONTAINS\", \"expression\": \".*Yes.*\" } ```", + "type": "string" + }, + "matchOperation": { + "description": "Match operation to use for evaluating rewards.", + "enum": [ + "MATCH_OPERATION_UNSPECIFIED", + "REGEX_CONTAINS", + "PARTIAL_MATCH", + "EXACT_MATCH" + ], + "enumDescriptions": [ + "Default value. A user error will be returned if not set.", + "Equivalent to [GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/string_functions#regexp_contains) `REGEX_CONTAINS(target, expression)`.", + "The match operation returns `true` if expression is a substring of the target.", + "The match operation returns `true` expression is an exact match of the target." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples": { + "description": "Sample reinforcement tuning user data in the training dataset. The contents are truncated for better UI showing.", + "id": "GoogleCloudAiplatformV1beta1ReinforcementTuningUserDatasetExamples", + "properties": { + "userDatasetExamples": { + "description": "List of user datasset examples showing to user.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest": { "description": "Request message for MetadataService.DeleteContextChildrenRequest.", "id": "GoogleCloudAiplatformV1beta1RemoveContextChildrenRequest", @@ -77475,6 +83644,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ResponseFormat": { + "description": "Configuration for the model to configure output formatting and delivery.", + "id": "GoogleCloudAiplatformV1beta1ResponseFormat", + "properties": { + "audio": { + "$ref": "GoogleCloudAiplatformV1beta1AudioResponseFormat", + "description": "Audio output format." + }, + "image": { + "$ref": "GoogleCloudAiplatformV1beta1ImageResponseFormat", + "description": "Image output format." + }, + "text": { + "$ref": "GoogleCloudAiplatformV1beta1TextResponseFormat", + "description": "Text output format." + }, + "video": { + "$ref": "GoogleCloudAiplatformV1beta1VideoResponseFormat", + "description": "Video output format." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata": { "description": "Runtime operation information for DatasetService.RestoreDatasetVersion.", "id": "GoogleCloudAiplatformV1beta1RestoreDatasetVersionOperationMetadata", @@ -77492,6 +83684,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest": { + "description": "Request message for SandboxEnvironmentService.ResumeSandboxEnvironment.", + "id": "GoogleCloudAiplatformV1beta1ResumeSandboxEnvironmentRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ResumeScheduleRequest": { "description": "Request message for ScheduleService.ResumeSchedule.", "id": "GoogleCloudAiplatformV1beta1ResumeScheduleRequest", @@ -78912,13 +85110,19 @@ "description": "Required. The category of the default container image.", "enum": [ "DEFAULT_CONTAINER_CATEGORY_UNSPECIFIED", - "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE" + "DEFAULT_CONTAINER_CATEGORY_COMPUTER_USE", + "DEFAULT_CONTAINER_CATEGORY_SHELL_SANDBOX" ], "enumDescriptions": [ "The default value. This value is unused.", - "The default container image for Computer Use." + "The default container image for Computer Use.", + "The default container image for Shell Sandbox." ], "type": "string" + }, + "resources": { + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateResourceRequirements", + "description": "Optional. Resource requests and limits for the default container." } }, "type": "object" @@ -78927,9 +85131,43 @@ "description": "Configuration for egress control of sandbox instances.", "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfig", "properties": { + "customerVpcNetwork": { + "description": "Optional. The customer VPC network that sandbox egress is routed into.", + "type": "string" + }, + "dnsPeeringConfigs": { + "description": "Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig" + }, + "type": "array" + }, "internetAccess": { "description": "Optional. Whether to allow internet access.", "type": "boolean" + }, + "networkAttachment": { + "description": "Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig": { + "description": "Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC.", + "id": "GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig", + "properties": { + "domain": { + "description": "Required. The DNS name suffix of the zone being peered to, e.g., \"my-internal-domain.corp.\". Must end with a dot.", + "type": "string" + }, + "targetNetwork": { + "description": "Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible.", + "type": "string" + }, + "targetProject": { + "description": "Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project.", + "type": "string" } }, "type": "object" @@ -84063,6 +90301,145 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy": { + "description": "Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent.", + "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicy", + "properties": { + "agent": { + "description": "Required. The name of the agent in Agent Registry that is affected by this policy.", + "type": "string" + }, + "agentIdentity": { + "description": "Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID`", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicy was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the SemanticGovernancePolicy.", + "type": "string" + }, + "displayName": { + "description": "Optional. The user-defined name of the SemanticGovernancePolicy.", + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.", + "type": "string" + }, + "mcpTools": { + "description": "Optional. The McpTools that are affected by this policy.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Resource name of the SemanticGovernancePolicy.", + "type": "string" + }, + "naturalLanguageConstraint": { + "description": "Required. The natural language constraint of the SemanticGovernancePolicy.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicy was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine": { + "description": "Define a singleton SemanticGovernancePolicyEngine resource under a project and location.", + "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyEngine", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "gatewayConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1GatewayConfig" + }, + "description": "Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed.", + "type": "object" + }, + "ipAddress": { + "description": "Output only. The private IPv4 address of the PSC endpoint.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project}/locations/{location}/semanticGovernancePolicyEngine", + "type": "string" + }, + "pscForwardingRule": { + "description": "Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}", + "readOnly": true, + "type": "string" + }, + "pscServiceAttachment": { + "description": "Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the SemanticGovernancePolicyEngine.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "ACTIVE", + "DEPROVISIONING", + "INACTIVE", + "FAILED" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "A provisioning operation is in progress. The engine will transition to ACTIVE on success or FAILED on failure.", + "The engine and all of its gateway configurations are provisioned and ready to serve traffic.", + "A deprovisioning operation is in progress. The engine will transition to INACTIVE on success or FAILED on failure.", + "The engine has no provisioned infrastructure: either never provisioned, or successfully deprovisioned.", + "The most recent provisioning or deprovisioning operation failed. The engine may have partial infrastructure that needs explicit deprovision; the engine may be either re-provisioned or deprovisioned to recover." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool": { + "description": "Represents a governance policy applied to MCP tools used by an Agent.", + "id": "GoogleCloudAiplatformV1beta1SemanticGovernancePolicyMcpTool", + "properties": { + "mcpServer": { + "description": "Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project}/locations/{location}/mcpServers/{mcp_server}`", + "type": "string" + }, + "tools": { + "description": "Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", @@ -84078,6 +90455,68 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ServingProfile": { + "description": "Configures the serving behavior for a resource-less GenAI serving.", + "id": "GoogleCloudAiplatformV1beta1ServingProfile", + "properties": { + "cmekConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", + "description": "CMEK configuration for the ServingProfile." + }, + "createTime": { + "description": "Output only. Timestamp when the ServingProfile was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the ServingProfile.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the ServingProfile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The resource name of the ServingProfile.", + "type": "string" + }, + "scope": { + "description": "Required. The specific API this ServingProfile applies to.", + "enum": [ + "SERVING_PROFILE_SCOPE_UNSPECIFIED", + "GEMINI_LIVE", + "INTERACTIONS_API", + "RESPONSE_API" + ], + "enumDescriptions": [ + "Default value. This value is unused. When users create a ServingProfile, they must choose a scope.", + "The scope for Gemini Live.", + "The scope for Interactions API.", + "The scope for Response API." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the ServingProfile was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig": { + "description": "Configuration for Customer-Managed Encryption Keys (CMEK).", + "id": "GoogleCloudAiplatformV1beta1ServingProfileCmekConfig", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Required. The customer-managed encryption key spec for the Serving Profile." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Session": { "description": "A session contains a set of actions between users and Vertex agents.", "id": "GoogleCloudAiplatformV1beta1Session", @@ -84193,6 +90632,11 @@ "publisherModelConfig": { "$ref": "GoogleCloudAiplatformV1beta1PublisherModelConfig", "description": "Required. The publisher model config." + }, + "updateMask": { + "description": "Optional. The fields of `publisher_model_config` to overwrite. If empty, the entire config is replaced. If set, only the listed fields are overwritten and the others are left unchanged; this lets you update one setting (for example `inference_event_logging_config`) without clearing its siblings.", + "format": "google-fieldmask", + "type": "string" } }, "type": "object" @@ -84285,6 +90729,37 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig": { + "description": "SingleReinforcementTuningRewardConfig defines a single reward function configuration for RL tuning. Each reward calculation/evaluation consists of two stages: 1. Stage 1: Parses the part of information important from sample response via regex extract, or simply takes the sample response unmodified. 2. Stage 2: Calls the configured reward scorer to compute the reward.", + "id": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", + "properties": { + "autoraterScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningAutoraterScorer", + "description": "ReinforcementTuningAutoraterScorer is used to score parsed responses based on score computed by an autorater." + }, + "cloudRunRewardScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningCloudRunRewardScorer", + "description": "ReinforcementTuningCloudRunRewardScorer is used to score parsed responses by calling a Cloud Run service." + }, + "codeExecutionRewardScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningCodeExecutionRewardScorer", + "description": "ReinforcementTuningCodeExecutionRewardScorer is used to score parsed responses for code execution use cases." + }, + "parseResponseConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningParseResponseConfig", + "description": "Defines how to parse sample response. For example, given a sample response for evaluating the reward, users might want to extract the text only between `` and `` in the sample response, and keeps only the last one in case there are multiple such tags. To achieve such a purpose, they can define a regex `\".*(.*?)\"` using the ReinforcementTuningParseResponseConfig.ResponseParseType.REGEX_EXTRACT parse type." + }, + "rewardName": { + "description": "A unique reward name for identifying each single reinforcement tuning reward.", + "type": "string" + }, + "stringMatchRewardScorer": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningStringMatchRewardScorer", + "description": "ReinforcementTuningStringMatchRewardScorer is used to score parsed responses for simple string matching use cases against reference answers." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Skill": { "description": "A skill.", "id": "GoogleCloudAiplatformV1beta1Skill", @@ -84391,7 +90866,7 @@ }, "skill": { "$ref": "GoogleCloudAiplatformV1beta1Skill", - "description": "Output only. The state of the Skill at this revision. TODO(b/503772996) Use a different proto for skill data included in skill revision", + "description": "Output only. The state of the Skill at this revision.", "readOnly": true }, "state": { @@ -84966,6 +91441,10 @@ "description": "Required. Represents the ID of the schema. Must be 1-63 characters, start with a lowercase letter, and consist of lowercase letters, numbers, and hyphens.", "type": "string" }, + "jsonSchema": { + "description": "Optional. Represents the JSON Schema of the structured memories.", + "type": "any" + }, "memoryType": { "description": "Optional. Represents the type of the structured memories associated with the schema. If not set, then `STRUCTURED_PROFILE` will be used.", "enum": [ @@ -86891,6 +93370,31 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1TextResponseFormat": { + "description": "Configuration for text-specific output formatting.", + "id": "GoogleCloudAiplatformV1beta1TextResponseFormat", + "properties": { + "mimeType": { + "description": "Optional. The IANA standard MIME type of the response.", + "enum": [ + "MIME_TYPE_UNSPECIFIED", + "APPLICATION_JSON", + "TEXT_PLAIN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "JSON output format.", + "Plain text output format." + ], + "type": "string" + }, + "schema": { + "description": "Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON.", + "type": "any" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ThresholdConfig": { "description": "The config for feature monitoring threshold.", "id": "GoogleCloudAiplatformV1beta1ThresholdConfig", @@ -87035,6 +93539,10 @@ "$ref": "GoogleCloudAiplatformV1beta1EnterpriseWebSearch", "description": "Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance." }, + "exaAiSearch": { + "$ref": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", + "description": "Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation" + }, "functionDeclarations": { "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided.", "items": { @@ -87162,15 +93670,23 @@ "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", "properties": { + "enablePromptInjectionDetection": { + "description": "Optional. Enables the prompt injection detection check on computer-use request.", + "type": "boolean" + }, "environment": { "description": "Required. The environment being operated.", "enum": [ "ENVIRONMENT_UNSPECIFIED", - "ENVIRONMENT_BROWSER" + "ENVIRONMENT_BROWSER", + "ENVIRONMENT_MOBILE", + "ENVIRONMENT_DESKTOP" ], "enumDescriptions": [ "Defaults to browser.", - "Operates in a web browser." + "Operates in a web browser.", + "Operates in a mobile environment.", + "Operates in a desktop environment." ], "type": "string" }, @@ -87199,6 +93715,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ToolExaAiSearch": { + "description": "ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding.", + "id": "GoogleCloudAiplatformV1beta1ToolExaAiSearch", + "properties": { + "apiKey": { + "description": "Required. The API key for ExaAiSearch.", + "type": "string" + }, + "customConfigs": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This field can be used to pass any parameter from the Exa.ai Search API.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ToolGoogleSearch": { "description": "GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.", "id": "GoogleCloudAiplatformV1beta1ToolGoogleSearch", @@ -87348,6 +93883,15 @@ }, "description": "Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { \"source_policy\": { \"include_domains\": [\"google.com\", \"wikipedia.org\"], \"exclude_domains\": [\"example.com\"] }, \"fetch_policy\": { \"max_age_seconds\": 3600 } }", "type": "object" + }, + "enableDataRetention": { + "deprecated": true, + "description": "Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", + "type": "boolean" + }, + "enableZeroDataRetention": { + "description": "Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is \"false\" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is \"true\", the Parallel Web Search for Grounding - ZDR subscription will be used.", + "type": "boolean" } }, "type": "object" @@ -88316,6 +94860,11 @@ "description": "Output only. Statistics for preference optimization.", "readOnly": true }, + "reinforcementTuningDataStats": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetStats", + "description": "Output only. Statistics for reinforcement tuning.", + "readOnly": true + }, "supervisedTuningDataStats": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats", "description": "The SFT Tuning data stats." @@ -88415,6 +94964,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PreferenceOptimizationSpec", "description": "Tuning Spec for Preference Optimization." }, + "reinforcementTuningSpec": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningSpec", + "description": "Tuning Spec for Reinforcement Tuning." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -89249,6 +95802,64 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest": { + "description": "Request message for GenAiTuningService.ValidateReinforcementTuningReward.", + "id": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardRequest", + "properties": { + "compositeRewardConfig": { + "$ref": "GoogleCloudAiplatformV1beta1CompositeReinforcementTuningRewardConfig", + "description": "Optional. Composite reward function configuration for reinforcement tuning." + }, + "example": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningExample", + "description": "Required. The example to validate the reward configuration." + }, + "sampleResponse": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Required. The sample response for validating the reward configuration." + }, + "singleRewardConfig": { + "$ref": "GoogleCloudAiplatformV1beta1SingleReinforcementTuningRewardConfig", + "description": "Optional. Single Reward function configuration for reinforcement tuning." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse": { + "description": "Response message for GenAiTuningService.ValidateReinforcementTuningReward.", + "id": "GoogleCloudAiplatformV1beta1ValidateReinforcementTuningRewardResponse", + "properties": { + "error": { + "description": "Output only. In case of an error, this field will be populated with a detailed error message to help with debugging.", + "readOnly": true, + "type": "string" + }, + "overallReward": { + "description": "Output only. The overall weighted reward. For a CompositeReinforcementTuningRewardConfig, this is the weighted average of all rewards. For a SingleReinforcementTuningRewardConfig, this will be the value of the single reward.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "rewardDetails": { + "additionalProperties": { + "format": "float", + "type": "number" + }, + "deprecated": true, + "description": "Output only. Deprecated: Use reward_info_details instead. A map from reward name to the calculated reward for the reward function. This field will only be populated when a CompositeReinforcementTuningRewardConfig is provided in the request. It will not be set for a SingleReinforcementTuningRewardConfig.", + "readOnly": true, + "type": "object" + }, + "rewardInfoDetails": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1ReinforcementTuningRewardInfo" + }, + "description": "A map from reward name to reward info.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Value": { "description": "Value is the value of the field.", "id": "GoogleCloudAiplatformV1beta1Value", @@ -89555,6 +96166,50 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1VideoResponseFormat": { + "description": "Configuration for video-specific output formatting.", + "id": "GoogleCloudAiplatformV1beta1VideoResponseFormat", + "properties": { + "aspectRatio": { + "description": "The aspect ratio for the video output.", + "enum": [ + "ASPECT_RATIO_UNSPECIFIED", + "ASPECT_RATIO_SIXTEEN_BY_NINE", + "ASPECT_RATIO_NINE_BY_SIXTEEN" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "16:9 aspect ratio.", + "9:16 aspect ratio." + ], + "type": "string" + }, + "delivery": { + "description": "Optional. Delivery mode for the generated content.", + "enum": [ + "DELIVERY_UNSPECIFIED", + "INLINE", + "URI" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Generated bytes are returned inline in the response.", + "Generated content is stored and a URI is returned." + ], + "type": "string" + }, + "duration": { + "description": "Optional. The duration for the video output.", + "format": "google-duration", + "type": "string" + }, + "gcsUri": { + "description": "Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1VoiceConfig": { "description": "Configuration for a voice.", "id": "GoogleCloudAiplatformV1beta1VoiceConfig", diff --git a/src/apis/aiplatform/index.ts b/src/apis/aiplatform/index.ts index fb2e0512a75..112d16fe81a 100644 --- a/src/apis/aiplatform/index.ts +++ b/src/apis/aiplatform/index.ts @@ -35,10 +35,7 @@ export function aiplatform< >( this: GoogleConfigurable, versionOrOptions: - | 'v1' - | aiplatform_v1.Options - | 'v1beta1' - | aiplatform_v1beta1.Options + 'v1' | aiplatform_v1.Options | 'v1beta1' | aiplatform_v1beta1.Options ) { return getAPI('aiplatform', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 5db1be6fc3f..673e65a32be 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -125,6 +125,7 @@ export namespace aiplatform_v1 { indexEndpoints: Resource$Indexendpoints; indexes: Resource$Indexes; media: Resource$Media; + memoryBanks: Resource$Memorybanks; metadataStores: Resource$Metadatastores; migratableResources: Resource$Migratableresources; modelDeploymentMonitoringJobs: Resource$Modeldeploymentmonitoringjobs; @@ -132,6 +133,7 @@ export namespace aiplatform_v1 { notebookExecutionJobs: Resource$Notebookexecutionjobs; notebookRuntimes: Resource$Notebookruntimes; notebookRuntimeTemplates: Resource$Notebookruntimetemplates; + onlineEvaluators: Resource$Onlineevaluators; operations: Resource$Operations; persistentResources: Resource$Persistentresources; pipelineJobs: Resource$Pipelinejobs; @@ -141,6 +143,8 @@ export namespace aiplatform_v1 { ragEngineConfig: Resource$Ragengineconfig; reasoningEngines: Resource$Reasoningengines; schedules: Resource$Schedules; + semanticGovernancePolicies: Resource$Semanticgovernancepolicies; + servingProfiles: Resource$Servingprofiles; skills: Resource$Skills; specialistPools: Resource$Specialistpools; studies: Resource$Studies; @@ -172,6 +176,7 @@ export namespace aiplatform_v1 { this.indexEndpoints = new Resource$Indexendpoints(this.context); this.indexes = new Resource$Indexes(this.context); this.media = new Resource$Media(this.context); + this.memoryBanks = new Resource$Memorybanks(this.context); this.metadataStores = new Resource$Metadatastores(this.context); this.migratableResources = new Resource$Migratableresources(this.context); this.modelDeploymentMonitoringJobs = @@ -184,6 +189,7 @@ export namespace aiplatform_v1 { this.notebookRuntimeTemplates = new Resource$Notebookruntimetemplates( this.context ); + this.onlineEvaluators = new Resource$Onlineevaluators(this.context); this.operations = new Resource$Operations(this.context); this.persistentResources = new Resource$Persistentresources(this.context); this.pipelineJobs = new Resource$Pipelinejobs(this.context); @@ -193,6 +199,10 @@ export namespace aiplatform_v1 { this.ragEngineConfig = new Resource$Ragengineconfig(this.context); this.reasoningEngines = new Resource$Reasoningengines(this.context); this.schedules = new Resource$Schedules(this.context); + this.semanticGovernancePolicies = new Resource$Semanticgovernancepolicies( + this.context + ); + this.servingProfiles = new Resource$Servingprofiles(this.context); this.skills = new Resource$Skills(this.context); this.specialistPools = new Resource$Specialistpools(this.context); this.studies = new Resource$Studies(this.context); @@ -207,14 +217,34 @@ export namespace aiplatform_v1 { * Experimental parameters for video generation. */ export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperiments { + /** + * Optional. If true, anchors the last frame in video generation by generating a custom border mask. + */ + anchorLastFrame?: boolean | null; + /** + * CFG scale for video-transform, perf-generation, a2v, video-textures models. + */ + cfgScale?: number | null; /** * Optional. Video codec to use for output. */ codec?: string | null; + /** + * Optional. Color alignment configuration. + */ + colorAlignment?: Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig; /** * Conditioning frames for veo experimental models ONLY, not to be confused with keyframes (ID:31) in GenerateVideoRequest. */ conditioningFrames?: Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame[]; + /** + * Generic key-value pairs for experimental parameters. This allows adding new parameters without changing the dataplane binary. + */ + customParameters?: {[key: string]: any} | null; + /** + * Optional. Colorspace to be used for all EXR inputs. + */ + exrColorSpaceOverride?: string | null; /** * Human pose parameters for Pose Control */ @@ -227,6 +257,14 @@ export namespace aiplatform_v1 { * Number of diffusion steps */ numDiffusionSteps?: number | null; + /** + * Optional. Omni Rewriter configuration. + */ + omniRewriter?: Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig; + /** + * The original REST API request JSON sent by the user, in the instances/parameters format. Preserved for saving alongside output artifacts so users can reproduce their requests. This field is populated by the API handler and is not user-settable. + */ + originalRequestJson?: string | null; /** * Prompt chunks for "ProModel" prompting. If set, the prompt will not be rewritten, and top-level prompt ignored. */ @@ -235,6 +273,18 @@ export namespace aiplatform_v1 { * Optional tag for tracking the source of this request. Allowed values: "colab", "comfyui", "curl", "flowresearch", "vertexstudio". Unrecognized tags are recorded as "unknown" in metrics. Tags do not affect video generation behavior. Up to 16 characters, ASCII alphanumeric, hyphens, and underscores only. */ requestOriginTag?: string | null; + /** + * Optional. Scheduling configuration. + */ + schedulingConfig?: Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig; + /** + * Parameters for seamless (edge-continuous) video generation, enabling temporal looping and/or spatial tessellation. + */ + seamless?: Schema$CloudAiLargeModelsVisionSeamless; + /** + * Optional. Spatial alignment configuration. + */ + spatialAlignment?: Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig; /** * If true (default), truncate input videos that exceed the model's maximum frame count by applying a frame_selection_config to __video_file__ inputs. Set to false to preserve the existing fail-fast behavior. */ @@ -248,6 +298,15 @@ export namespace aiplatform_v1 { */ videoTransformStrength?: number | null; } + /** + * Configuration for color alignment. + */ + export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsColorAlignmentConfig { + /** + * Optional. If true, enable alignment. + */ + enable?: boolean | null; + } export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsConditioningFrame { /** * The index of the frame, starts with zero and must be a multiple of 8. @@ -258,6 +317,37 @@ export namespace aiplatform_v1 { */ image?: Schema$CloudAiLargeModelsVisionGenerateVideoRequestImage; } + /** + * Configuration for Omni Rewriter. + */ + export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsOmniRewriterConfig { + /** + * Optional. Maximum duration of a chunk in seconds. + */ + maxChunkDuration?: number | null; + /** + * Optional. FPS used to generate gemini chunks for video inputs. + */ + rewriterInputFps?: number | null; + } + /** + * Configuration for spatial alignment. + */ + export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsSpatialAlignmentConfig { + /** + * Optional. If true, enable alignment. + */ + enable?: boolean | null; + } + /** + * Scheduling configuration for Veo Experimental. + */ + export interface Schema$CloudAiLargeModelsVisionGenerateVideoExperimentsVESchedulingConfig { + /** + * Optional. If true, enable retries on transient errors with default backoff. + */ + enableRetry?: boolean | null; + } /** * The image bytes or Cloud Storage URI to make the prediction on. */ @@ -518,6 +608,20 @@ export namespace aiplatform_v1 { */ score?: number | null; } + export interface Schema$CloudAiLargeModelsVisionSeamless { + /** + * If true, the generated video will be loopable (seamless time looping). + */ + loop?: boolean | null; + /** + * If true, the generated video will be tessellatable as a horizontal tessellation. + */ + tessellateHorizontal?: boolean | null; + /** + * If true, the generated video will be tessellatable as a vertical tessellation. + */ + tessellateVertical?: boolean | null; + } export interface Schema$CloudAiLargeModelsVisionSemanticFilterResponse { /** * Class labels of the bounding boxes that failed the semantic filtering. Bounding box coordinates. @@ -583,6 +687,19 @@ export namespace aiplatform_v1 { */ extensions?: Array<{[key: string]: any}> | null; } + /** + * Metadata for the ActivateOnlineEvaluator operation. + */ + export interface Schema$GoogleCloudAiplatformV1ActivateOnlineEvaluatorOperationMetadata { + /** + * Common part of operation metadata. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } + /** + * Request message for ActivateOnlineEvaluator. + */ + export interface Schema$GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest {} /** * Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy. */ @@ -656,6 +773,143 @@ export namespace aiplatform_v1 { */ measurement?: Schema$GoogleCloudAiplatformV1Measurement; } + /** + * A Vertex agent contains instructions and configurations for the LLM to execute a certain task. + */ + export interface Schema$GoogleCloudAiplatformV1Agent { + /** + * Required. The base agent for the agent. Supported values: * `antigravity-preview-05-2026` + */ + base_agent?: string | null; + /** + * Optional. The base environment configuration for the agent. Valid types: * A string value for the environment ID, or `remote` for the default. * A struct value for the `environment_config`. + */ + base_environment?: any | null; + /** + * Output only. The time the agent was created. + */ + created?: string | null; + /** + * Optional. The description of the agent. + */ + description?: string | null; + /** + * Immutable. The user-specified ID for the agent. This ID becomes the final component of the agent resource name. If not provided, Vertex AI will generate a value for this ID. The ID can be up to 63 characters and must match the regular expression `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`. + */ + id?: string | null; + /** + * Optional. The metadata for the agent. + */ + metadata?: {[key: string]: string} | null; + /** + * Identifier. The resource name of the agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. + */ + name?: string | null; + /** + * Output only. The object type of the resource. For agents, the value is `agent`. + */ + object?: string | null; + /** + * Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. + */ + system_instruction?: string | null; + /** + * Optional. The tools available to the agent. + */ + tools?: Schema$GoogleCloudAiplatformV1AgentTool[]; + /** + * Output only. The time the agent was last updated. + */ + updated?: string | null; + } + /** + * Represents configuration for an Agent. + */ + export interface Schema$GoogleCloudAiplatformV1AgentConfig { + /** + * Required. Unique identifier of the agent. This ID is used to refer to this agent, e.g., in AgentEvent.author, or in the `sub_agents` field. It must be unique within the `agents` map. + */ + agentId?: string | null; + /** + * Optional. The type or class of the agent (e.g., "LlmAgent", "RouterAgent", "ToolUseAgent"). Useful for the autorater to understand the expected behavior of the agent. + */ + agentType?: string | null; + /** + * Optional. A high-level description of the agent's role and responsibilities. Critical for evaluating if the agent is routing tasks correctly. + */ + description?: string | null; + /** + * Optional. Provides instructions for the LLM model, guiding the agent's behavior. Can be static or dynamic. Dynamic instructions can contain placeholders like {variable_name\} that will be resolved at runtime using the `AgentEvent.state_delta` field. + */ + instruction?: string | null; + /** + * Optional. The list of valid agent IDs that this agent can delegate to. This defines the directed edges in the multi-agent system graph topology. + */ + subAgents?: string[] | null; + /** + * Optional. The list of tools available to this agent. + */ + tools?: Schema$GoogleCloudAiplatformV1Tool[]; + } + /** + * Represents data specific to multi-turn agent evaluations. + */ + export interface Schema$GoogleCloudAiplatformV1AgentData { + /** + * Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + */ + agents?: {[key: string]: Schema$GoogleCloudAiplatformV1AgentConfig} | null; + /** + * Optional. A chronological list of conversation turns. Each turn represents a logical execution cycle (e.g., User Input -\> Agent Response). + */ + turns?: Schema$GoogleCloudAiplatformV1ConversationTurn[]; + } + /** + * Represents a single event in the execution trace. + */ + export interface Schema$GoogleCloudAiplatformV1AgentEvent { + /** + * Optional. The list of tools that were active/available to the agent at the time of this event. This overrides the `AgentConfig.tools` if set. + */ + activeTools?: Schema$GoogleCloudAiplatformV1Tool[]; + /** + * Required. The ID of the agent or entity that generated this event. Use "user" to denote events generated by the end-user. + */ + author?: string | null; + /** + * Required. The content of the event (e.g., text response, tool call, tool response). + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. The timestamp when the event occurred. + */ + eventTime?: string | null; + /** + * Optional. The change in the session state caused by this event. This is a key-value map of fields that were modified or added by the event. + */ + stateDelta?: {[key: string]: any} | null; + } + /** + * A tool provides a list of actions available to the Agent during the process of executing a task. + */ + export interface Schema$GoogleCloudAiplatformV1AgentTool { + /** + * Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. + */ + headers?: {[key: string]: string} | null; + /** + * Optional. The name of the MCP server. Only applicable when `type` is `mcp_server`. + */ + name?: string | null; + /** + * Required. The type of the tool. Supported types: * `code_execution` * `filesystem` * `google_search` * `mcp_server` * `url_context` + */ + type?: string | null; + /** + * Optional. The URL for the MCP server endpoint. Only applicable when `type` is `mcp_server`. + */ + url?: string | null; + } /** * The aggregation result for the entire dataset and all metrics. */ @@ -958,6 +1212,103 @@ export namespace aiplatform_v1 { */ outputName?: string | null; } + /** + * Configuration for audio-specific output formatting. + */ + export interface Schema$GoogleCloudAiplatformV1AudioResponseFormat { + /** + * Optional. Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus). + */ + bitRate?: number | null; + /** + * Optional. Delivery mode for the generated content. + */ + delivery?: string | null; + /** + * Optional. The MIME type of the audio output. + */ + mimeType?: string | null; + /** + * Optional. Sample rate for the generated audio in Hertz. + */ + sampleRate?: number | null; + } + /** + * The transcription of an audio part. For multi-speaker audio, each speaker segment is a separate Part with its own AudioTranscription carrying the speaker_label. + */ + export interface Schema$GoogleCloudAiplatformV1AudioTranscription { + /** + * Optional. A label identifying the speaker of this audio segment (e.g. "spk_1", "spk_2"). Present when diarization is set. + */ + speakerLabel?: string | null; + /** + * Required. The transcription text of this audio segment. + */ + text?: string | null; + /** + * Optional. Detailed word-level transcriptions and timing details. Present when word_timestamp is set. + */ + words?: Schema$GoogleCloudAiplatformV1AudioTranscriptionWordInfo[]; + } + /** + * Configuration for speech recognition (transcription). + */ + export interface Schema$GoogleCloudAiplatformV1AudioTranscriptionConfig { + /** + * Optional. A list of phrases to bias the ASR model towards. + */ + adaptationPhrases?: string[] | null; + /** + * Optional. A list of custom vocabulary phrases to bias the speech recognition model toward recognizing specific terms. + */ + customVocabulary?: string[] | null; + /** + * Optional. Configures speaker diarization. + */ + diarization?: boolean | null; + /** + * Optional. The model will detect the language automatically. + */ + languageAuto?: Schema$GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto; + /** + * Optional. Specifies one or more languages in the audio. + */ + languageHints?: Schema$GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints; + /** + * Optional. Configures word-level timestamp generation. + */ + wordTimestamp?: boolean | null; + } + /** + * Indicates the language of the audio should be automatically detected. + */ + export interface Schema$GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageAuto {} + /** + * Provides hints to the model about possible languages present in the audio. + */ + export interface Schema$GoogleCloudAiplatformV1AudioTranscriptionConfigLanguageHints { + /** + * Required. BCP-47 language codes. At least one must be specified. + */ + languageCodes?: string[] | null; + } + /** + * Information about a single recognized word. + */ + export interface Schema$GoogleCloudAiplatformV1AudioTranscriptionWordInfo { + /** + * Optional. End offset in time of the word relative to the start of the audio. + */ + endOffset?: string | null; + /** + * Optional. Start offset in time of the word relative to the start of the audio. + */ + startOffset?: string | null; + /** + * Required. Transcript of the word. + */ + word?: string | null; + } /** * Request message for AugmentPrompt. */ @@ -1096,11 +1447,11 @@ export namespace aiplatform_v1 { serviceAccount?: string | null; } /** - * A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. + * A description of resources that to large degree are decided by Agent Platform, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. */ export interface Schema$GoogleCloudAiplatformV1AutomaticResources { /** - * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Vertex AI may be unable to scale beyond certain replica number. + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, a no upper bound for scaling under heavy traffic will be assume, though Agent Platform may be unable to scale beyond certain replica number. */ maxReplicaCount?: number | null; /** @@ -1236,7 +1587,7 @@ export namespace aiplatform_v1 { */ maxReplicaCount?: number | null; /** - * Immutable. The number of machine replicas used at the start of the batch operation. If not set, Vertex AI decides starting number, not greater than max_replica_count + * Immutable. The number of machine replicas used at the start of the batch operation. If not set, Agent Platform decides starting number, not greater than max_replica_count */ startingReplicaCount?: number | null; } @@ -1960,6 +2311,10 @@ export namespace aiplatform_v1 { * Responses from model or agent. */ export interface Schema$GoogleCloudAiplatformV1CandidateResponse { + /** + * Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This field is used to provide the full output of an agent's run, including all turns and events, for direct evaluation. + */ + agentData?: Schema$GoogleCloudAiplatformV1AgentData; /** * Required. The name of the candidate that produced the response. */ @@ -1989,6 +2344,10 @@ export namespace aiplatform_v1 { * Required. The candidate that is being evaluated. The value is the same as the candidate name in the EvaluationRequest. */ candidate?: string | null; + /** + * Output only. Error while evaluating the candidate for the metric. + */ + error?: Schema$GoogleRpcStatus; /** * Optional. The explanation for the metric. */ @@ -2138,10 +2497,52 @@ export namespace aiplatform_v1 { */ inferenceTimeout?: string | null; } + /** + * Specifies configuration for exporting evaluation results to Cloud Logging. + */ + export interface Schema$GoogleCloudAiplatformV1CloudLoggingConfig { + /** + * Optional. Google Cloud project to write logs to. Defaults to the request project. + */ + project?: string | null; + /** + * Optional. MonitoredResource labels to associate the log with. The backend will automatically inject project and location. + */ + resourceLabels?: {[key: string]: string} | null; + /** + * Optional. MonitoredResource type. Defaults to "global" if unspecified. + */ + resourceType?: string | null; + /** + * Optional. Tracing context for the evaluation run. + */ + tracingContext?: Schema$GoogleCloudAiplatformV1CloudLoggingConfigTracingContext; + } + /** + * Tracing context for Observability correlation. + */ + export interface Schema$GoogleCloudAiplatformV1CloudLoggingConfigTracingContext { + /** + * Optional. Unique identifier for a conversation (session thread), used to store and correlate messages within a conversation. The value corresponds to the `gen_ai.conversation.id` field in the the OpenTelemetry GenAI attributes. + */ + conversationId?: string | null; + /** + * Optional. ID of the Cloud Trace span associated with the current operation in which the log is being written. e.g., `7a2190356c3fc94b`. If a span is being evaluated, this field should be populated. + */ + spanId?: string | null; + /** + * Optional. Trace ID being written to Cloud Trace in association with this log entry. e.g., `12345`, the numeric ID from the resource name. If a trace or span is being evaluated, this field should be populated. + */ + traceId?: string | null; + } /** * Result of executing the ExecutableCode. Generated only when the `CodeExecution` tool is used. */ export interface Schema$GoogleCloudAiplatformV1CodeExecutionResult { + /** + * Optional. The identifier of the `ExecutableCode` part this result is for. Only populated if the corresponding `ExecutableCode` has an id. + */ + id?: string | null; /** * Required. Outcome of the code execution. */ @@ -2457,6 +2858,23 @@ export namespace aiplatform_v1 { */ updateTime?: string | null; } + /** + * Represents a single turn/invocation in the conversation. + */ + export interface Schema$GoogleCloudAiplatformV1ConversationTurn { + /** + * Optional. The list of events that occurred during this turn. + */ + events?: Schema$GoogleCloudAiplatformV1AgentEvent[]; + /** + * Optional. A unique identifier for the turn. Useful for referencing specific turns across systems. + */ + turnId?: string | null; + /** + * Required. The 0-based index of the turn in the conversation sequence. + */ + turnIndex?: number | null; + } /** * Details of ModelService.CopyModel operation. */ @@ -2796,6 +3214,15 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Metadata for the CreateOnlineEvaluator operation. + */ + export interface Schema$GoogleCloudAiplatformV1CreateOnlineEvaluatorOperationMetadata { + /** + * Common part of operation metadata. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } /** * Details of operations that perform create PersistentResource. */ @@ -2835,6 +3262,15 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Runtime operation metadata for ServingProfileService.CreateServingProfile. + */ + export interface Schema$GoogleCloudAiplatformV1CreateServingProfileOperationMetadata { + /** + * Output only. The standard operation metadata for Vertex AI. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } /** * Runtime operation information for SpecialistPoolService.CreateSpecialistPool. */ @@ -3392,7 +3828,7 @@ export namespace aiplatform_v1 { */ machineSpec?: Schema$GoogleCloudAiplatformV1MachineSpec; /** - * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Vertex CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). + * Immutable. The maximum number of replicas that may be deployed on when the traffic against it increases. If the requested value is too large, the deployment will error, but if deployment succeeds then the ability to scale to that many replicas is guaranteed (barring service outages). If traffic increases beyond what its replicas at maximum may handle, a portion of the traffic will be dropped. If this value is not provided, will use min_replica_count as the default value. The value of this field impacts the charge against Agent Platform CPU and GPU quotas. Specifically, you will be charged for (max_replica_count * number of cores in the selected machine type) and (max_replica_count * number of GPUs per replica in the selected machine type). */ maxReplicaCount?: number | null; /** @@ -3508,6 +3944,15 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Metadata for the DeleteOnlineEvaluator operation. + */ + export interface Schema$GoogleCloudAiplatformV1DeleteOnlineEvaluatorOperationMetadata { + /** + * Generic operation metadata. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } /** * Details of operations that perform deletes of any entities. */ @@ -3985,6 +4430,15 @@ export namespace aiplatform_v1 { */ publisherModel?: string | null; } + /** + * Request message for SemanticGovernancePolicyEngineService.DeprovisionSemanticGovernancePolicyEngine. + */ + export interface Schema$GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest { + /** + * Optional. If true, the operation bypass checks on current state and force the deprovisioning operation. + */ + force?: boolean | null; + } export interface Schema$GoogleCloudAiplatformV1DestinationFeatureSetting { /** * Specify the field name in the export destination. If not specified, Feature ID is used. @@ -4517,7 +4971,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest { /** - * Optional. Autorater config used for evaluation. + * Optional. Autorater config used for evaluation. Not applicable for predefined metrics (PredefinedMetricSpec); the server uses its own model configuration for predefined metrics and this field is ignored. */ autoraterConfig?: Schema$GoogleCloudAiplatformV1AutoraterConfig; /** @@ -5090,6 +5544,47 @@ export namespace aiplatform_v1 { */ name?: string | null; } + /** + * EvaluationMetric is a resource that represents a reusable metric configuration. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationMetric { + /** + * Output only. The time when the EvaluationMetric was created. + */ + createTime?: string | null; + /** + * Optional. A description of the EvaluationMetric. + */ + description?: string | null; + /** + * Required. The user-friendly display name for the EvaluationMetric. + */ + displayName?: string | null; + /** + * Optional. Customer-managed encryption key spec for this EvaluationMetric. If set, this EvaluationMetric will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1EncryptionSpec; + /** + * Optional. The Google Cloud Storage URI that stores the metric specification.. + */ + gcsUri?: string | null; + /** + * Optional. Labels for the evaluation metric. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The metric configuration. Only LLMMetric and CustomCodeExecutionMetric are supported. + */ + metric?: Schema$GoogleCloudAiplatformV1Metric; + /** + * Identifier. The resource name of the EvaluationMetric. Format: `projects/{project\}/locations/{location\}/evaluationMetrics/{evaluation_metric\}` + */ + name?: string | null; + /** + * Output only. The time when the EvaluationMetric was last updated. + */ + updateTime?: string | null; + } /** * Config for parsing LLM responses. It can be used to parse the LLM response to be evaluated, or the LLM response from LLM-based metrics/Autoraters. */ @@ -5112,6 +5607,10 @@ export namespace aiplatform_v1 { * Prompt to be evaluated. This can represent a single-turn prompt or a multi-turn conversation for agent evaluations. */ export interface Schema$GoogleCloudAiplatformV1EvaluationPrompt { + /** + * Optional. Represents the complete execution trace of a multi-turn conversation, which can involve single or multiple agents. This serves as the input context for agent scraping. + */ + agentData?: Schema$GoogleCloudAiplatformV1AgentData; /** * Prompt template data. */ @@ -5120,6 +5619,10 @@ export namespace aiplatform_v1 { * Text prompt. */ text?: string | null; + /** + * Optional. The generated user scenario used to drive multi-turn agent running results. + */ + userScenario?: Schema$GoogleCloudAiplatformV1EvaluationPromptUserScenario; /** * Fields and values that can be used to populate the prompt template. */ @@ -5134,6 +5637,19 @@ export namespace aiplatform_v1 { */ values?: {[key: string]: Schema$GoogleCloudAiplatformV1Content} | null; } + /** + * User scenario to help simulate multi-turn agent running results. + */ + export interface Schema$GoogleCloudAiplatformV1EvaluationPromptUserScenario { + /** + * Required. The plan for the conversation, used to drive the multi-turn agent run and generate the simulated agent evaluation dataset. + */ + conversationPlan?: string | null; + /** + * Required. The prompt that starts the conversation between the simulated user and the agent under test. + */ + startingPrompt?: string | null; + } /** * A single evaluation request supporting input for both single-turn model generation and multi-turn agent execution traces. Valid input modes: 1. Inference Mode: `prompt` is set (containing text or AgentData context). 2. Offline Eval Mode: `prompt` is unset, and `candidate_responses` contains `agent_data` (the completed execution trace). Validation Rule: Either `prompt` must be set, OR at least one of the `candidate_responses` must contain `agent_data`. */ @@ -5294,10 +5810,18 @@ export namespace aiplatform_v1 { * Optional. The autorater config for the evaluation run. */ autoraterConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigAutoraterConfig; + /** + * Optional. Configuration for exporting evaluation results to Cloud Logging. + */ + cloudLoggingConfig?: Schema$GoogleCloudAiplatformV1CloudLoggingConfig; /** * Optional. Specifications for custom dataset-level aggregations. */ datasetCustomMetrics?: Schema$GoogleCloudAiplatformV1DatasetCustomMetric[]; + /** + * Optional. Specifications for loss analysis. Each config can be specified for one metric. + */ + lossAnalysisConfig?: Schema$GoogleCloudAiplatformV1LossAnalysisConfig[]; /** * Optional. The metrics to be calculated in the evaluation run. Required when analysis_configs is not set. */ @@ -5366,6 +5890,10 @@ export namespace aiplatform_v1 { * Optional. Agent run config. */ agentRunConfig?: Schema$GoogleCloudAiplatformV1EvaluationRunInferenceConfigAgentRunConfig; + /** + * Optional. Contains the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. + */ + agents?: {[key: string]: Schema$GoogleCloudAiplatformV1AgentConfig} | null; /** * Optional. Generation config. */ @@ -5378,6 +5906,10 @@ export namespace aiplatform_v1 { * Optional. The parallelism of the evaluation run for the inference step. If not specified, the default parallelism will be used. */ parallelism?: number | null; + /** + * Optional. The prompt template used for inference. The values for variables in the prompt template are defined in EvaluationItem.EvaluationPrompt.PromptTemplateData.values. If not specified, the prompt template in the EvaluationConfig will be used. + */ + promptTemplate?: Schema$GoogleCloudAiplatformV1EvaluationRunEvaluationConfigPromptTemplate; } /** * Configuration for Agent Run. @@ -5585,6 +6117,12 @@ export namespace aiplatform_v1 { * EvaluationSet is a collection of related EvaluationItems that are evaluated together. */ export interface Schema$GoogleCloudAiplatformV1EvaluationSet { + /** + * Optional. Static configurations for each agent associated with the items in this set. Key: `agent_id` (matches the `author` field in `events`). Value: The static configuration of the agent. + */ + agentConfigs?: { + [key: string]: Schema$GoogleCloudAiplatformV1AgentConfig; + } | null; /** * Output only. Timestamp when this item was created. */ @@ -5593,6 +6131,10 @@ export namespace aiplatform_v1 { * Required. The display name of the EvaluationSet. */ displayName?: string | null; + /** + * Optional. Customer-managed encryption key spec for this EvaluationSet. If set, this EvaluationSet and its sub-resources will be secured by this key. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1EncryptionSpec; /** * Required. The EvaluationItems that are part of this dataset. */ @@ -5837,6 +6379,10 @@ export namespace aiplatform_v1 { * Required. The code to be executed. */ code?: string | null; + /** + * Optional. Unique identifier of the `ExecutableCode` part. The server returns the `CodeExecutionResult` with the matching `id`. + */ + id?: string | null; /** * Required. Programming language of the `code`. */ @@ -7755,6 +8301,10 @@ export namespace aiplatform_v1 { * Optional. The function parameters and values in JSON object format. See FunctionDeclaration.parameters for parameter details. */ args?: {[key: string]: any} | null; + /** + * Optional. The unique id of the function call. If populated, the client to execute the `function_call` and return the response with the matching `id`. + */ + id?: string | null; /** * Optional. The name of the function to call. Matches FunctionDeclaration.name. */ @@ -7822,6 +8372,10 @@ export namespace aiplatform_v1 { * The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a `FunctionCall` made based on model prediction. */ export interface Schema$GoogleCloudAiplatformV1FunctionResponse { + /** + * Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call `id`. + */ + id?: string | null; /** * Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name. */ @@ -7886,6 +8440,43 @@ export namespace aiplatform_v1 { */ inlineData?: Schema$GoogleCloudAiplatformV1FunctionResponseBlob; } + /** + * Configuration for a single gateway. + */ + export interface Schema$GoogleCloudAiplatformV1GatewayConfig { + /** + * Optional. Additional consumer projects permitted to attach their own PSC endpoint to this gateway's ServiceAttachment. This is the "decoupled" mode, where the customer creates the PSC endpoint in a project other than this gateway's `network` project. Each listed project is VPC-SC enforced: it must be within the caller's service perimeter. The owning SemanticGovernancePolicyEngine's own project is always permitted implicitly and need not be listed. Format: project ID or number. + */ + allowedProjects?: string[] | null; + /** + * Output only. The fully qualified record name of the created A-record in Cloud DNS. + */ + dnsRecord?: string | null; + /** + * Optional. FQDN of the private DNS zone to create DNS record set for PSC endpoint. + */ + dnsZoneName?: string | null; + /** + * Output only. The private IP address of the PSC endpoint. + */ + ipAddress?: string | null; + /** + * Optional. The URI of the network resource where PSC-E will be provisioned. if not provided `default` network will be used. Format: projects/{project\}/global/networks/{network\} + */ + network?: string | null; + /** + * Output only. The self-link or name of the Private Service Connect endpoint forwarding rule. + */ + pscEndpoint?: string | null; + /** + * Output only. The state of the Gateway configuration. + */ + state?: string | null; + /** + * Optional. The URI of the subnetwork resource where PSC-E will be provisioned. if not provided `default` subnet will be used from the same {location\} Format: projects/{project\}/regions/{region\}/subnetworks/{subnetwork\} + */ + subnetwork?: string | null; + } /** * The Google Cloud Storage location where the output is to be written to. */ @@ -8148,6 +8739,32 @@ export namespace aiplatform_v1 { */ generatedRubrics?: Schema$GoogleCloudAiplatformV1Rubric[]; } + /** + * Request message for EvaluationAnalyticsService.GenerateLossClusters. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateLossClustersRequest { + /** + * Required. Configuration for the analysis algorithm. Analysis for multiple metrics and multiple candidates could be specified. + */ + configs?: Schema$GoogleCloudAiplatformV1LossAnalysisConfig[]; + /** + * Reference to a persisted EvaluationSet. The service will read items from this set. + */ + evaluationSet?: string | null; + /** + * Inline evaluation results. Useful for ephemeral analysis in notebooks/SDKs where data isn't persisted. + */ + inlineResults?: Schema$GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList; + } + /** + * A wrapper to allow providing a list of items inline. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateLossClustersRequestEvaluationResultList { + /** + * Required. The list of evaluation results to analyze. + */ + evaluationResults?: Schema$GoogleCloudAiplatformV1EvaluationResult[]; + } /** * Request message for MemoryBankService.GenerateMemories. Maximum size is 8 MB. */ @@ -8290,6 +8907,36 @@ export namespace aiplatform_v1 { */ syntheticExamples?: Schema$GoogleCloudAiplatformV1SyntheticExample[]; } + /** + * Request message for DataFoundryService.GenerateUserScenarios. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateUserScenariosRequest { + /** + * Optional. A map containing the static configurations for each agent in the system. Key: agent_id (matches the `author` field in events). Value: The static configuration of the agent. Required unless `gemini_agent_config` is set, in which case the agents map and `root_agent_id` are derived from the referenced Gemini Agent. + */ + agents?: {[key: string]: Schema$GoogleCloudAiplatformV1AgentConfig} | null; + /** + * Optional. Allows the scenario generation to use cross region models. When this flag is set, the service may route traffic to other regions if a model is unavailable in the current region (e.g., to a `global` endpoint). If a fully-qualified model endpoint resource name with a different region than the request location is provided elsewhere in the request, this flag must be set to true or the request will fail. + */ + allowCrossRegionModel?: boolean | null; + /** + * Optional. The agent id to identify the root agent. Required unless `gemini_agent_config` is set, in which case it is derived from the referenced Gemini Agent. + */ + rootAgentId?: string | null; + /** + * Required. Configuration for generating user scenarios. + */ + userScenarioGenerationConfig?: Schema$GoogleCloudAiplatformV1UserScenarioGenerationConfig; + } + /** + * Response message for DataFoundryService.GenerateUserScenarios. + */ + export interface Schema$GoogleCloudAiplatformV1GenerateUserScenariosResponse { + /** + * The generated user scenarios used to simulate multi-turn agent running results and agent evaluation. + */ + userScenarios?: Schema$GoogleCloudAiplatformV1UserScenario[]; + } /** * Generate video response. */ @@ -8336,6 +8983,10 @@ export namespace aiplatform_v1 { * 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. Config for audio transcription (speech recognition). + */ + audioTranscriptionConfig?: Schema$GoogleCloudAiplatformV1AudioTranscriptionConfig; /** * 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. */ @@ -8349,7 +9000,7 @@ export namespace aiplatform_v1 { */ frequencyPenalty?: number | null; /** - * Optional. Config for image generation features. + * Optional. Config for image generation features. Deprecated: Use `response_format.image` instead. */ imageConfig?: Schema$GoogleCloudAiplatformV1ImageConfig; /** @@ -8369,7 +9020,11 @@ export namespace aiplatform_v1 { */ presencePenalty?: number | null; /** - * Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. + * Optional. New response format field for the model to configure output formatting and delivery. + */ + responseFormat?: Schema$GoogleCloudAiplatformV1ResponseFormat[]; + /** + * Optional. When this field is set, response_schema must be omitted and response_mime_type must be set to `application/json`. Deprecated: Use `response_format` instead. */ responseJsonSchema?: any | null; /** @@ -8377,7 +9032,7 @@ export namespace aiplatform_v1 { */ responseLogprobs?: boolean | null; /** - * 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. + * 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. Deprecated: Use `response_format` instead. */ responseMimeType?: string | null; /** @@ -8385,7 +9040,7 @@ export namespace aiplatform_v1 { */ responseModalities?: string[] | null; /** - * 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`. + * 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`. Deprecated: Use `response_format` instead. */ responseSchema?: Schema$GoogleCloudAiplatformV1Schema; /** @@ -8522,10 +9177,35 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1GoogleMaps { /** - * Optional. If true, include the widget context token in the response. + * Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. */ enableWidget?: boolean | null; + /** + * Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + */ + groundingTypes?: Schema$GoogleCloudAiplatformV1GoogleMapsGroundingTypes; + } + /** + * Defines the types of Google Maps grounding that can be enabled and their configurations. + */ + export interface Schema$GoogleCloudAiplatformV1GoogleMapsGroundingTypes { + /** + * Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. + */ + places?: Schema$GoogleCloudAiplatformV1GoogleMapsPlaces; + /** + * Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + */ + routing?: Schema$GoogleCloudAiplatformV1GoogleMapsRouting; } + /** + * Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. + */ + export interface Schema$GoogleCloudAiplatformV1GoogleMapsPlaces {} + /** + * Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + */ + export interface Schema$GoogleCloudAiplatformV1GoogleMapsRouting {} /** * Tool to retrieve public web data for grounding, powered by Google. */ @@ -8748,7 +9428,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1GroundingMetadata { /** - * 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. + * Optional. Output only. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and will no longer be populated once removed. 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; /** @@ -8767,6 +9447,10 @@ export namespace aiplatform_v1 { * Optional. Output only. Metadata related to the retrieval grounding source. */ retrievalMetadata?: Schema$GoogleCloudAiplatformV1RetrievalMetadata; + /** + * 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. + */ + retrievalQueries?: string[] | null; /** * 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. */ @@ -8938,6 +9622,27 @@ export namespace aiplatform_v1 { */ mimeType?: string | null; } + /** + * Configuration for image-specific output formatting. + */ + export interface Schema$GoogleCloudAiplatformV1ImageResponseFormat { + /** + * Optional. The aspect ratio for the image output. + */ + aspectRatio?: string | null; + /** + * Optional. Delivery mode for the generated content. + */ + delivery?: string | null; + /** + * Optional. The size of the image output. + */ + imageSize?: string | null; + /** + * Optional. The MIME type of the image output. + */ + mimeType?: string | null; + } /** * Describes the location from where we import data into a Dataset, together with the labels that will be applied to the DataItems and the Annotations. */ @@ -8981,6 +9686,116 @@ export namespace aiplatform_v1 { * Response message for DatasetService.ImportData. */ export interface Schema$GoogleCloudAiplatformV1ImportDataResponse {} + /** + * Request message for EvaluationManagementService.ImportEvaluationSet. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequest { + /** + * Source for loading Agent Engine sessions. + */ + agentEngineSource?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource; + /** + * BigQuery source with column mappings. + */ + bigquerySource?: Schema$GoogleCloudAiplatformV1BigQueryRequestSet; + /** + * Source for loading data directly from Cloud Trace. + */ + cloudTraceSource?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource; + /** + * Required. The EvaluationSet to create. Used to specify 'display_name' and 'metadata'. The 'evaluation_items' field is ignored and populated by the import process. + */ + evaluationSet?: Schema$GoogleCloudAiplatformV1EvaluationSet; + /** + * Required. The Cloud Storage location where the resulting EvaluationItem payloads will be stored. + */ + gcsDestination?: Schema$GoogleCloudAiplatformV1GcsDestination; + /** + * Google Cloud Storage location. + */ + gcsSource?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource; + /** + * Inline source for small payloads (< 4MB). + */ + inlineSource?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource; + } + /** + * Source for loading Agent Engine sessions. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestAgentEngineSource { + /** + * Required. Location for the Agent Engine sessions. + */ + location?: string | null; + /** + * Required. Project ID for the Agent Engine sessions. + */ + projectId?: string | null; + /** + * Required. Reasoning Engine ID for the Agent Engine sessions. + */ + reasoningEngineId?: string | null; + /** + * Required. Session IDs for the Agent Engine sessions to retrieve. + */ + sessionIds?: string[] | null; + } + /** + * Source for loading traces directly from Cloud Trace. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestCloudTraceSource { + /** + * Required. Project ID for the Cloud Trace. + */ + projectId?: string | null; + /** + * Optional. Session IDs to import traces for. If both trace_ids and session_ids are specified, the union of the two will be imported. + */ + sessionIds?: string[] | null; + /** + * Optional. Trace IDs to import. + */ + traceIds?: string[] | null; + } + /** + * Source for loading data from Cloud Storage. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestGcsSource { + /** + * Required. The Cloud Storage location of the input data. + */ + gcsUri?: string | null; + /** + * Required. Schema configuration for the input data. + */ + importSchemaConfig?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig; + } + /** + * Configuration for the input data format. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig { + /** + * Required. The format of the input data. + */ + dataFormat?: string | null; + /** + * Optional. Version of the data format. + */ + dataFormatVersion?: string | null; + } + /** + * Wrapper for inline data. + */ + export interface Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestInlineSource { + /** + * Required. The content of the inline data. + */ + content?: string | null; + /** + * Required. Schema configuration for the inline data. + */ + importSchemaConfig?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequestImportSchemaConfig; + } /** * Details of operations that perform import Feature values. */ @@ -9424,6 +10239,83 @@ export namespace aiplatform_v1 { */ vectorsCount?: string | null; } + /** + * Request message for MemoryBankService.IngestEvents. + */ + export interface Schema$GoogleCloudAiplatformV1IngestEventsRequest { + /** + * Ingest events directly from the request. + */ + directContentsSource?: Schema$GoogleCloudAiplatformV1IngestionDirectContentsSource; + /** + * Optional. If true, no revisions will be created for this request. + */ + disableMemoryRevisions?: boolean | null; + /** + * Optional. Forces a flush of all pending events in the stream and triggers memory generation immediately bypassing any conditions configured in the `generation_trigger_config`. + */ + forceFlush?: boolean | null; + /** + * Optional. Configuration for triggering memory generation from this ingestion. If not set, then the stream will be force flushed immediately. + */ + generationTriggerConfig?: Schema$GoogleCloudAiplatformV1MemoryGenerationTriggerConfig; + /** + * Optional. User-provided metadata for the generated memories. This is not generated by Memory Bank. + */ + metadata?: { + [key: string]: Schema$GoogleCloudAiplatformV1MemoryMetadataValue; + } | null; + /** + * Optional. The strategy to use when applying metadata to existing memories. + */ + metadataMergeStrategy?: string | null; + /** + * Optional. Timestamp of when the revision is considered expired. If not set, the memory revision will be kept until manually deleted. + */ + revisionExpireTime?: string | null; + /** + * Optional. Labels to be applied to the generated memory revisions. For example, you can use this to label a revision with its data source. + */ + revisionLabels?: {[key: string]: string} | null; + /** + * Optional. The TTL for the revision. The expiration time is computed: now + TTL. + */ + revisionTtl?: string | null; + /** + * Required. The scope of the memories that should be generated from the stream. Memories will be consolidated across memories with the same scope. Scope values cannot contain the wildcard character '*'. + */ + scope?: {[key: string]: string} | null; + /** + * Optional. The ID of the stream to ingest events into. If not provided, a new one will be created. + */ + streamId?: string | null; + } + /** + * Ingest events directly from the request. + */ + export interface Schema$GoogleCloudAiplatformV1IngestionDirectContentsSource { + /** + * Required. The events to ingest. + */ + events?: Schema$GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent[]; + } + /** + * A single event to ingest. + */ + export interface Schema$GoogleCloudAiplatformV1IngestionDirectContentsSourceEvent { + /** + * Required. The content of the event. + */ + content?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. A unique identifier for the event. If an event with the same event_id is ingested multiple times, it will be de-duplicated. + */ + eventId?: string | null; + /** + * Optional. The time at which the event occurred. If provided, this timestamp will be used for ordering events within a stream. If not provided, the server-side ingestion time will be used. + */ + eventTime?: string | null; + } /** * Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. */ @@ -9619,6 +10511,19 @@ export namespace aiplatform_v1 { */ executions?: Schema$GoogleCloudAiplatformV1Execution[]; } + /** + * Response message for AgentService.ListAgents. + */ + export interface Schema$GoogleCloudAiplatformV1ListAgentsResponse { + /** + * The agents matching the request. + */ + agents?: Schema$GoogleCloudAiplatformV1Agent[]; + /** + * A token to retrieve the next page of results. Pass this value as ListAgentsRequest.page_token in a subsequent call. + */ + nextPageToken?: string | null; + } /** * Response message for DatasetService.ListAnnotations. */ @@ -9801,6 +10706,19 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for EvaluationMetricService.ListEvaluationMetrics. + */ + export interface Schema$GoogleCloudAiplatformV1ListEvaluationMetricsResponse { + /** + * List of EvaluationMetrics in the requested page. + */ + evaluationMetrics?: Schema$GoogleCloudAiplatformV1EvaluationMetric[]; + /** + * A token to retrieve the next page of results. + */ + nextPageToken?: string | null; + } /** * Response message for EvaluationManagementService.ListEvaluationRuns. */ @@ -10165,6 +11083,19 @@ export namespace aiplatform_v1 { */ notebookRuntimeTemplates?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate[]; } + /** + * Response message for ListOnlineEvaluators. + */ + export interface Schema$GoogleCloudAiplatformV1ListOnlineEvaluatorsResponse { + /** + * A token to retrieve the next page. Absence of this field indicates there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of OnlineEvaluators matching the request. + */ + onlineEvaluators?: Schema$GoogleCloudAiplatformV1OnlineEvaluator[]; + } /** * Request message for VizierService.ListOptimalTrials. */ @@ -10305,6 +11236,19 @@ export namespace aiplatform_v1 { */ schedules?: Schema$GoogleCloudAiplatformV1Schedule[]; } + /** + * Response message for SemanticGovernancePolicyService.ListSemanticGovernancePolicies. + */ + export interface Schema$GoogleCloudAiplatformV1ListSemanticGovernancePoliciesResponse { + /** + * A token to retrieve the next page of results. Pass to ListSemanticGovernancePoliciesRequest.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * The list of SemanticGovernancePolicies. + */ + semanticGovernancePolicies?: Schema$GoogleCloudAiplatformV1SemanticGovernancePolicy[]; + } /** * Response message for SessionService.ListSessions. */ @@ -10520,6 +11464,19 @@ export namespace aiplatform_v1 { */ displayName?: string | null; } + /** + * Configuration for the loss analysis job. + */ + export interface Schema$GoogleCloudAiplatformV1LossAnalysisConfig { + /** + * Required. The candidate model/agent to analyze (e.g., "gemini-3.0-pro"). This targets the specific CandidateResult within the EvaluationResult. + */ + candidate?: string | null; + /** + * Required. The metric to analyze (e.g., "tool_use_quality"). This filters the EvaluationItems in the EvalSet to only those where EvaluationResult.metric matches this value. + */ + metric?: string | null; + } /** * Represents a mount configuration for Lustre file system. */ @@ -10546,7 +11503,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1MachineSpec { /** - * The number of accelerators to attach to the machine. For accelerator optimized machine types (https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Vertex will co-schedule the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Vertex will co-schedule 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled. + * The number of accelerators to attach to the machine. For [accelerator optimized machine types](https://cloud.google.com/compute/docs/accelerator-optimized-machines), One may set the accelerator_count from 1 to N for machine with N GPUs. If accelerator_count is less than or equal to N / 2, Agent Platform co-schedules the replicas of the model into the same VM to save cost. For example, if the machine type is a3-highgpu-8g, which has 8 H100 GPUs, one can set accelerator_count to 1 to 8. If accelerator_count is 1, 2, 3, or 4, Agent Platform co-schedules 8, 4, 2, or 2 replicas of the model into the same VM to save cost. When co-scheduling, CPU, memory and storage on the VM will be distributed to replicas on the VM. For example, one can expect a co-scheduled replica requesting 2 GPUs out of a 8-GPU VM will receive 25% of the CPU, memory and storage of the VM. Note that the feature is not compatible with multihost_gpu_node_count. When multihost_gpu_node_count is set, the co-scheduling will not be enabled. */ acceleratorCount?: number | null; /** @@ -10558,7 +11515,7 @@ export namespace aiplatform_v1 { */ gpuPartitionSize?: string | null; /** - * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. + * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/gemini-enterprise-agent-platform/machine-learning/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */ machineType?: string | null; /** @@ -10848,6 +11805,10 @@ export namespace aiplatform_v1 { * Optional. Specifies to trigger generation if the stream is inactive for the specified duration after the most recent event. The duration must have a minute-level granularity. */ idleDuration?: string | null; + /** + * Optional. Re-include the last N already-processed events in the next window. + */ + overlapEventCount?: number | null; } /** * Memory metadata. @@ -11426,7 +12387,7 @@ export namespace aiplatform_v1 { */ checkpoints?: Schema$GoogleCloudAiplatformV1Checkpoint[]; /** - * Input only. The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. + * The specification of the container that is to be used when deploying this Model. The specification is ingested upon ModelService.UploadModel, and all binaries it contains are copied and stored internally by Vertex AI. Not required for AutoML Models. */ containerSpec?: Schema$GoogleCloudAiplatformV1ModelContainerSpec; /** @@ -12893,6 +13854,27 @@ export namespace aiplatform_v1 { * The specification of a persistent disk to attach for the execution job. */ persistentDiskSpec?: Schema$GoogleCloudAiplatformV1PersistentDiskSpec; + /** + * Optional. Shielded VM configuration (for example, Secure Boot) for the execution VM. + */ + shieldedInstanceConfig?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig; + } + /** + * A set of Shielded VM options for the execution VM. Mirrors `google.cloud.notebooks.v2.ShieldedInstanceConfig`. See https://cloud.google.com/compute/docs/instances/modifying-shielded-vm. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobCustomEnvironmentSpecShieldedInstanceConfig { + /** + * Optional. Whether the VM instance has integrity monitoring enabled. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Optional. Whether the VM instance has Secure Boot enabled. Disabled by default. + */ + enableSecureBoot?: boolean | null; + /** + * Optional. Whether the VM instance has vTPM enabled. + */ + enableVtpm?: boolean | null; } /** * The Dataform Repository containing the input notebook. @@ -12932,7 +13914,46 @@ export namespace aiplatform_v1 { /** * Configuration for a Workbench Instances-based environment. */ - export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime {} + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntime { + /** + * A user-provided container image. The notebook executes inside this container on a managed container-host (COS) VM. + */ + customContainerImage?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage; + /** + * A specific Compute Engine VM image to run the notebook on. + */ + vmImage?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage; + } + /** + * The definition of a user-provided container image to run the notebook execution in. Mirrors `google.cloud.notebooks.v2.ContainerImage`. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeContainerImage { + /** + * Required. The path to the container image repository. For example: `gcr.io/{project_id\}/{image_name\}`. + */ + repository?: string | null; + /** + * Optional. The tag of the container image. If unset, defaults to `latest`. + */ + tag?: string | null; + } + /** + * The definition of a Compute Engine VM image to run the notebook execution on. Mirrors `google.cloud.notebooks.v2.VmImage`. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobWorkbenchRuntimeVmImage { + /** + * Use this VM image family to find the image; the newest image in this family is used. + */ + family?: string | null; + /** + * Use this VM image name to find the image. + */ + name?: string | null; + /** + * Required. The name of the Google Cloud project that this VM image belongs to. Format: `{project_id\}`. + */ + project?: string | null; + } /** * The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. */ @@ -13191,6 +14212,147 @@ export namespace aiplatform_v1 { */ postStartupScriptConfig?: Schema$GoogleCloudAiplatformV1PostStartupScriptConfig; } + /** + * An OnlineEvaluator contains the configuration for an Online Evaluation. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluator { + /** + * Required. Immutable. The name of the agent that the OnlineEvaluator evaluates periodically. This value is used to filter the traces with a matching cloud.resource_id and link the evaluation results with relevant dashboards/UIs. This field is immutable. Once set, it cannot be changed. + */ + agentResource?: string | null; + /** + * Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging). + */ + cloudObservability?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability; + /** + * Required. Configuration for the OnlineEvaluator. + */ + config?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorConfig; + /** + * Output only. Timestamp when the OnlineEvaluator was created. + */ + createTime?: string | null; + /** + * Optional. Human-readable name for the OnlineEvaluator. The name doesn't have to be unique. The name can consist of any UTF-8 characters. The maximum length is `63` characters. If the display name exceeds max characters, an `INVALID_ARGUMENT` error is returned. + */ + displayName?: string | null; + /** + * Required. A list of metric sources to be used for evaluating samples. At least one MetricSource must be provided. Right now, only predefined metrics and registered metrics are supported. Every registered metric must have `display_name` (or `title`) and `score_range` defined. Otherwise, the evaluations will fail. The maximum number of `metric_sources` is 25. + */ + metricSources?: Schema$GoogleCloudAiplatformV1MetricSource[]; + /** + * Identifier. The resource name of the OnlineEvaluator. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + */ + name?: string | null; + /** + * Output only. The state of the OnlineEvaluator. + */ + state?: string | null; + /** + * Output only. Contains additional information about the state of the OnlineEvaluator. This is used to provide more details in the event of a failure. + */ + stateDetails?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorStateDetails[]; + /** + * Output only. Timestamp when the OnlineEvaluator was last updated. + */ + updateTime?: string | null; + } + /** + * Data source for the OnlineEvaluator, based on Google Cloud Observability stack (Cloud Trace & Cloud Logging). + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservability { + /** + * Optional. Optional log view that will be used to query logs. If empty, the `_Default` view will be used. + */ + logView?: string | null; + /** + * Data source follows OpenTelemetry convention. + */ + openTelemetry?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry; + /** + * Scope online evaluation to single traces. + */ + traceScope?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope; + /** + * Optional. Optional trace view that will be used to query traces. If empty, the `_Default` view will be used. NOTE: This field is not supported yet and will be ignored if set. + */ + traceView?: string | null; + } + /** + * Defines a predicate for filtering based on a numeric value. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate { + /** + * Required. The comparison operator to apply. + */ + comparisonOperator?: string | null; + /** + * Required. The value to compare against. + */ + value?: number | null; + } + /** + * Configuration for data source following OpenTelemetry. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityOpenTelemetry { + /** + * Required. Defines which version OTel Semantic Convention the data follows. Can be "1.39.0" or newer. + */ + semconvVersion?: string | null; + } + /** + * If chosen, the online evaluator will evaluate single traces matching specified `filter`. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScope { + /** + * Optional. A list of predicates to filter traces. Multiple predicates are combined using AND. The maximum number of predicates is 10. + */ + filter?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate[]; + } + /** + * Defines a single filter predicate. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityTraceScopePredicate { + /** + * Filter on the duration of a trace (in seconds). + */ + duration?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate; + /** + * Filter on the total token usage within a trace. + */ + totalTokenUsage?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorCloudObservabilityNumericPredicate; + } + /** + * Configuration for sampling behavior of the OnlineEvaluator. The OnlineEvaluator runs at a fixed interval of 10 minutes. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorConfig { + /** + * Optional. The maximum number of evaluations to perform per run. If set to 0, the number is unbounded. + */ + maxEvaluatedSamplesPerRun?: string | null; + /** + * Random sampling method. + */ + randomSampling?: Schema$GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling; + } + /** + * Configuration for random sampling. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorConfigRandomSampling { + /** + * Required. The percentage of traces to sample for evaluation. Must be an integer between `1` and `100`. + */ + percentage?: number | null; + } + /** + * Contains additional information about the state of the OnlineEvaluator. + */ + export interface Schema$GoogleCloudAiplatformV1OnlineEvaluatorStateDetails { + /** + * Output only. Human-readable message describing the state of the OnlineEvaluator. + */ + message?: string | null; + } /** * Config for evaluation output. */ @@ -13434,6 +14596,10 @@ export namespace aiplatform_v1 { * 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. Audio (input or output) transcription. This is only set when this Part contains audio data. + */ + audioTranscription?: Schema$GoogleCloudAiplatformV1AudioTranscription; /** * Optional. The result of executing the ExecutableCode. */ @@ -13521,12 +14687,16 @@ export namespace aiplatform_v1 { * Request message for JobService.PauseModelDeploymentMonitoringJob. */ export interface Schema$GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest {} + /** + * Request message for SandboxEnvironmentService.PauseSandboxEnvironment. + */ + export interface Schema$GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest {} /** * Request message for ScheduleService.PauseSchedule. */ export interface Schema$GoogleCloudAiplatformV1PauseScheduleRequest {} /** - * Represents the spec of persistent disk options. + * Represents the spec of persistent disk and hyperdisk options. */ export interface Schema$GoogleCloudAiplatformV1PersistentDiskSpec { /** @@ -13534,7 +14704,7 @@ export namespace aiplatform_v1 { */ diskSizeGb?: string | null; /** - * Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) + * Type of the disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) "pd-standard" (Persistent Disk Hard Disk Drive) "pd-balanced" (Balanced Persistent Disk) "pd-extreme" (Extreme Persistent Disk) "hyperdisk-balanced" (Hyperdisk Balanced) "hyperdisk-extreme" (Hyperdisk Extreme) "hyperdisk-balanced-high-availability" (Hyperdisk Balanced High Availability) "hyperdisk-ml" (Hyperdisk ML) "hyperdisk-throughput" (Hyperdisk Throughput) */ diskType?: string | null; } @@ -16040,6 +17210,10 @@ export namespace aiplatform_v1 { * Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". */ agentFramework?: string | null; + /** + * Optional. Configuration for building container image. + */ + buildSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec; /** * Optional. Declarations for object class methods in OpenAPI specification format. */ @@ -16073,6 +17247,19 @@ export namespace aiplatform_v1 { */ sourceCodeSpec?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecSourceCodeSpec; } + /** + * Specification for building container image. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec { + /** + * Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project\}/serviceAccounts/{service_account\}` or `{service_account\}@{project\}.iam.gserviceaccount.com` + */ + serviceAccount?: string | null; + /** + * Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project\}/locations/{location\}/workerPools/{worker_pool\}` + */ + workerPool?: string | null; + } /** * Specification for deploying from a container image. */ @@ -16081,11 +17268,19 @@ export namespace aiplatform_v1 { * Required. The Artifact Registry Docker image URI (e.g., us-central1-docker.pkg.dev/my-project/my-repo/my-image:tag) of the container image that is to be run on each worker replica. */ imageUri?: string | null; + /** + * Optional. The port the container listens on. Defaults to 8080 if unset. + */ + port?: number | null; } /** * The specification of a Reasoning Engine deployment. */ export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpec { + /** + * Optional. Agent Gateway configuration for the Reasoning Engine deployment. + */ + agentGatewayConfig?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig; /** * Optional. Concurrency for each container and agent server. Recommended value: 2 * cpu + 1. Defaults to 9. */ @@ -16119,6 +17314,37 @@ export namespace aiplatform_v1 { */ secretEnv?: Schema$GoogleCloudAiplatformV1SecretEnvVar[]; } + /** + * Agent Gateway configuration for a Reasoning Engine deployment. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfig { + /** + * Optional. Configuration for traffic originating from the Reasoning Engine. When unset, outgoing traffic is not routed through an Agent Gateway. + */ + agentToAnywhereConfig?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig; + /** + * Optional. Configuration for traffic targeting the Reasoning Engine. When unset, incoming traffic is not routed through an Agent Gateway. + */ + clientToAgentConfig?: Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig; + } + /** + * Configuration for traffic originating from a Reasoning Engine. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigAgentToAnywhereConfig { + /** + * Required. The resource name of the Agent Gateway for outbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `AGENT_TO_ANYWHERE`. Format: `projects/{project\}/locations/{location\}/agentGateways/{agent_gateway\}` + */ + agentGateway?: string | null; + } + /** + * Configuration for traffic targeting a Reasoning Engine. + */ + export interface Schema$GoogleCloudAiplatformV1ReasoningEngineSpecDeploymentSpecAgentGatewayConfigClientToAgentConfig { + /** + * Required. The resource name of the Agent Gateway to use for inbound traffic. It must be set to a Google-managed gateway whose `governed_access_path` is `CLIENT_TO_AGENT`. Format: `projects/{project\}/locations/{location\}/agentGateways/{agent_gateway\}` + */ + agentGateway?: string | null; + } /** * User-provided package specification, containing pickled object and package requirements. */ @@ -16419,6 +17645,27 @@ export namespace aiplatform_v1 { */ replicaHours?: number | null; } + /** + * Configuration for the model to configure output formatting and delivery. + */ + export interface Schema$GoogleCloudAiplatformV1ResponseFormat { + /** + * Audio output format. + */ + audio?: Schema$GoogleCloudAiplatformV1AudioResponseFormat; + /** + * Image output format. + */ + image?: Schema$GoogleCloudAiplatformV1ImageResponseFormat; + /** + * Text output format. + */ + text?: Schema$GoogleCloudAiplatformV1TextResponseFormat; + /** + * Video output format. + */ + video?: Schema$GoogleCloudAiplatformV1VideoResponseFormat; + } /** * Runtime operation information for DatasetService.RestoreDatasetVersion. */ @@ -16432,6 +17679,10 @@ export namespace aiplatform_v1 { * Request message for JobService.ResumeModelDeploymentMonitoringJob. */ export interface Schema$GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest {} + /** + * Request message for SandboxEnvironmentService.ResumeSandboxEnvironment. + */ + export interface Schema$GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest {} /** * Request message for ScheduleService.ResumeSchedule. */ @@ -17191,15 +18442,48 @@ export namespace aiplatform_v1 { * Required. The category of the default container image. */ defaultContainerCategory?: string | null; + /** + * Optional. Resource requests and limits for the default container. + */ + resources?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplateResourceRequirements; } /** * Configuration for egress control of sandbox instances. */ export interface Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfig { + /** + * Optional. The customer VPC network that sandbox egress is routed into. + */ + customerVpcNetwork?: string | null; + /** + * Optional. DNS peering configurations that allow sandbox egress to resolve customer-internal domains via the customer VPC. + */ + dnsPeeringConfigs?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig[]; /** * Optional. Whether to allow internet access. */ internetAccess?: boolean | null; + /** + * Optional. The name of the customer VPC NetworkAttachment used to draw a PSC interface IP into the customer VPC for sandbox egress. + */ + networkAttachment?: string | null; + } + /** + * Configuration for peering a customer's private DNS zone so that sandbox egress can resolve customer-internal domains via the customer VPC. + */ + export interface Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplateEgressControlConfigDnsPeeringConfig { + /** + * Required. The DNS name suffix of the zone being peered to, e.g., "my-internal-domain.corp.". Must end with a dot. + */ + domain?: string | null; + /** + * Required. The VPC network name in the target_project where the DNS zone specified by 'domain' is visible. + */ + targetNetwork?: string | null; + /** + * Required. The project ID hosting the Cloud DNS managed zone that contains the 'domain'. The Vertex AI Service Agent requires the dns.peer role on this project. + */ + targetProject?: string | null; } /** * Represents a network port in a container. @@ -20609,6 +21893,103 @@ export namespace aiplatform_v1 { */ text?: string | null; } + /** + * Represents a governance policy applied to a specific Agent and optionally a specific Tool within that Agent. + */ + export interface Schema$GoogleCloudAiplatformV1SemanticGovernancePolicy { + /** + * Required. The name of the agent in Agent Registry that is affected by this policy. + */ + agent?: string | null; + /** + * Output only. Represents the principal of the agent, used by the Policy Decision Point (PDP) for governance checks. For more information, see https://docs.cloud.google.com/agent-builder/agent-engine/agent-identity Format: `principal://TRUST_DOMAIN/NAMESPACE/AGENT_NAME` Example: `principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID` + */ + agentIdentity?: string | null; + /** + * Output only. Timestamp when this SemanticGovernancePolicy was created. + */ + createTime?: string | null; + /** + * Optional. The description of the SemanticGovernancePolicy. + */ + description?: string | null; + /** + * Optional. The user-defined name of the SemanticGovernancePolicy. + */ + displayName?: string | null; + /** + * Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. + */ + etag?: string | null; + /** + * Optional. The McpTools that are affected by this policy. + */ + mcpTools?: Schema$GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool[]; + /** + * Identifier. Resource name of the SemanticGovernancePolicy. + */ + name?: string | null; + /** + * Required. The natural language constraint of the SemanticGovernancePolicy. + */ + naturalLanguageConstraint?: string | null; + /** + * Output only. Timestamp when this SemanticGovernancePolicy was last updated. + */ + updateTime?: string | null; + } + /** + * Define a singleton SemanticGovernancePolicyEngine resource under a project and location. + */ + export interface Schema$GoogleCloudAiplatformV1SemanticGovernancePolicyEngine { + /** + * Output only. Timestamp when this SemanticGovernancePolicyEngine was created. + */ + createTime?: string | null; + /** + * Optional. Configurations for gateways. The keys are user-defined names for each gateway. At most 5 gateway configurations are allowed. + */ + gatewayConfigs?: { + [key: string]: Schema$GoogleCloudAiplatformV1GatewayConfig; + } | null; + /** + * Output only. The private IPv4 address of the PSC endpoint. + */ + ipAddress?: string | null; + /** + * Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + */ + name?: string | null; + /** + * Output only. The URI of the PSC endpoint resource created in customer project. Format: projects/{project\}/regions/{region\}/forwardingRules/{forwarding_rule\} + */ + pscForwardingRule?: string | null; + /** + * Output only. URI of the PSC attachment resource provided by SGP. Format: projects/{project\}/regions/{region\}/serviceAttachments/{service_attachment\} + */ + pscServiceAttachment?: string | null; + /** + * Output only. The state of the SemanticGovernancePolicyEngine. + */ + state?: string | null; + /** + * Output only. Timestamp when this SemanticGovernancePolicyEngine was last updated. + */ + updateTime?: string | null; + } + /** + * Represents a governance policy applied to MCP tools used by an Agent. + */ + export interface Schema$GoogleCloudAiplatformV1SemanticGovernancePolicyMcpTool { + /** + * Required. The resource name of the McpServer in Agent Registry that is affected by this policy. Format: `projects/{project\}/locations/{location\}/mcpServers/{mcp_server\}` + */ + mcpServer?: string | null; + /** + * Optional. The resource names of the McpTools used by the Agent that is affected by this policy. If not specified, the policy applies to all McpTools in the McpServer. + */ + tools?: string[] | null; + } /** * Configuration for the use of custom service account to run the workloads. */ @@ -21802,6 +23183,19 @@ export namespace aiplatform_v1 { */ validationDatasetUri?: string | null; } + /** + * Metadata for the SuspendOnlineEvaluator operation. + */ + export interface Schema$GoogleCloudAiplatformV1SuspendOnlineEvaluatorOperationMetadata { + /** + * Common part of operation metadata. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } + /** + * Request message for SuspendOnlineEvaluator. + */ + export interface Schema$GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest {} /** * Request message for FeatureOnlineStoreAdminService.SyncFeatureView. */ @@ -22131,6 +23525,19 @@ export namespace aiplatform_v1 { */ maxWallTime?: string | null; } + /** + * Configuration for text-specific output formatting. + */ + export interface Schema$GoogleCloudAiplatformV1TextResponseFormat { + /** + * Optional. The IANA standard MIME type of the response. + */ + mimeType?: string | null; + /** + * Optional. The JSON schema that the output should conform to. Only applicable when mime_type is APPLICATION_JSON. + */ + schema?: any | null; + } /** * The storage details for TFRecord output content. */ @@ -22245,6 +23652,10 @@ export namespace aiplatform_v1 { * Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance. */ enterpriseWebSearch?: Schema$GoogleCloudAiplatformV1EnterpriseWebSearch; + /** + * Optional. Uses Exa.ai to search for information to answer user queries. The search results will be grounded on Exa.ai and presented to the model for response generation + */ + exaAiSearch?: Schema$GoogleCloudAiplatformV1ToolExaAiSearch; /** * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 512 function declarations can be provided. */ @@ -22343,6 +23754,10 @@ export namespace aiplatform_v1 { * Tool to support computer use. */ export interface Schema$GoogleCloudAiplatformV1ToolComputerUse { + /** + * Optional. Enables the prompt injection detection check on computer-use request. + */ + enablePromptInjectionDetection?: boolean | null; /** * Required. The environment being operated. */ @@ -22365,6 +23780,19 @@ export namespace aiplatform_v1 { */ retrievalConfig?: Schema$GoogleCloudAiplatformV1RetrievalConfig; } + /** + * ExaAiSearch tool type. A tool that uses the Exa.ai search engine for grounding. + */ + export interface Schema$GoogleCloudAiplatformV1ToolExaAiSearch { + /** + * Required. The API key for ExaAiSearch. + */ + apiKey?: string | null; + /** + * Optional. This field can be used to pass any parameter from the Exa.ai Search API. + */ + customConfigs?: {[key: string]: any} | null; + } /** * GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. */ @@ -22463,6 +23891,14 @@ export namespace aiplatform_v1 { * Optional. Custom configs for ParallelAiSearch. This field can be used to pass any parameter from the Parallel.ai Search API. See the Parallel.ai documentation for the full list of available parameters and their usage: https://docs.parallel.ai/api-reference/search-beta/search Currently only `source_policy`, `excerpts`, `max_results`, `mode`, `fetch_policy` can be set via this field. For example: { "source_policy": { "include_domains": ["google.com", "wikipedia.org"], "exclude_domains": ["example.com"] \}, "fetch_policy": { "max_age_seconds": 3600 \} \} */ customConfigs?: {[key: string]: any} | null; + /** + * Optional. Deprecated: Use `enable_zero_data_retention` instead. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used. + */ + enableDataRetention?: boolean | null; + /** + * Optional. Instructs Vertex Grounding to use Parallel's Zero Data Retention Marketplace product. If this value is "false" or omitted, the Parallel Web Search for Grounding standard subscription will be used. If this value is "true", the Parallel Web Search for Grounding - ZDR subscription will be used. + */ + enableZeroDataRetention?: boolean | null; } /** * Input for tool parameter key match metric. @@ -23359,6 +24795,15 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Metadata for the UpdateOnlineEvaluator operation. + */ + export interface Schema$GoogleCloudAiplatformV1UpdateOnlineEvaluatorOperationMetadata { + /** + * Generic operation metadata. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + } /** * Details of operations that perform update PersistentResource. */ @@ -23598,6 +25043,44 @@ export namespace aiplatform_v1 { */ operation?: string | null; } + /** + * Output of user scenario generation. + */ + export interface Schema$GoogleCloudAiplatformV1UserScenario { + /** + * Conversation plan to drive multi-turn agent run and get simulated agent eval dataset. + */ + conversationPlan?: string | null; + /** + * Starting prompt for the conversation between simulated user and agent under the test. + */ + startingPrompt?: string | null; + /** + * Represents a short 3-5 word title for eval test case. + */ + testCaseTitle?: string | null; + } + /** + * User scenario generation configuration. + */ + export interface Schema$GoogleCloudAiplatformV1UserScenarioGenerationConfig { + /** + * Optional. Environment data in string type. + */ + environmentData?: string | null; + /** + * Optional. The model name to use for generation. It can be model name, e.g. "gemini-3-pro-preview". or the fully qualified name of the publisher model or endpoint. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + modelName?: string | null; + /** + * Optional. Simulation instruction to guide the user scenario generation. + */ + simulationInstruction?: string | null; + /** + * Required. The number of user scenarios to generate. The maximum number of scenarios that can be generated is 100. + */ + userScenarioCount?: string | null; + } /** * Value is the value of the field. */ @@ -23735,6 +25218,27 @@ export namespace aiplatform_v1 { */ startOffset?: string | null; } + /** + * Configuration for video-specific output formatting. + */ + export interface Schema$GoogleCloudAiplatformV1VideoResponseFormat { + /** + * The aspect ratio for the video output. + */ + aspectRatio?: string | null; + /** + * Optional. Delivery mode for the generated content. + */ + delivery?: string | null; + /** + * Optional. The duration for the video output. + */ + duration?: string | null; + /** + * Optional. The Google Cloud Storage URI to store the video output. Required for Vertex if delivery is URI. + */ + gcsUri?: string | null; + } /** * Configuration for a voice. */ @@ -25051,8 +26555,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Customjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -25352,8 +26855,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Customjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -25825,8 +27327,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datalabelingjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -26126,8 +27627,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datalabelingjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -26363,8 +27863,7 @@ export namespace aiplatform_v1 { create( params: Params$Resource$Datasets$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( @@ -26504,8 +28003,7 @@ export namespace aiplatform_v1 { delete( params: Params$Resource$Datasets$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( @@ -27487,8 +28985,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datasets$Annotationspecs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -27788,8 +29285,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datasets$Annotationspecs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -28284,8 +29780,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -28587,8 +30082,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datasets$Dataitems$Annotations$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -29052,8 +30546,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datasets$Dataitems$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -29353,8 +30846,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datasets$Dataitems$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -29570,8 +31062,7 @@ export namespace aiplatform_v1 { create( params: Params$Resource$Datasets$Datasetversions$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( @@ -29715,8 +31206,7 @@ export namespace aiplatform_v1 { delete( params: Params$Resource$Datasets$Datasetversions$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( @@ -30342,8 +31832,7 @@ export namespace aiplatform_v1 { restore( params: Params$Resource$Datasets$Datasetversions$Restore, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; restore( @@ -30833,8 +32322,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datasets$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -31134,8 +32622,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datasets$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -31609,8 +33096,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Datasets$Savedqueries$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -31910,8 +33396,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Datasets$Savedqueries$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -32387,8 +33872,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Deploymentresourcepools$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -32688,8 +34172,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Deploymentresourcepools$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -33222,8 +34705,7 @@ export namespace aiplatform_v1 { fetchPredictOperation( params: Params$Resource$Endpoints$Fetchpredictoperation, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; fetchPredictOperation( @@ -33714,8 +35196,7 @@ export namespace aiplatform_v1 { predictLongRunning( params: Params$Resource$Endpoints$Predictlongrunning, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; predictLongRunning( @@ -34550,8 +36031,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Endpoints$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -34851,8 +36331,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Endpoints$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -35205,8 +36684,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featuregroups$Features$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -35504,8 +36982,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featuregroups$Features$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -35830,8 +37307,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featuregroups$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -36128,8 +37604,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featuregroups$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -36481,8 +37956,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featureonlinestores$Featureviews$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -36784,8 +38258,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featureonlinestores$Featureviews$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -37111,8 +38584,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featureonlinestores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -37409,8 +38881,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featureonlinestores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -37910,8 +39381,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -38215,8 +39685,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featurestores$Entitytypes$Features$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -38682,8 +40151,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featurestores$Entitytypes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -38984,8 +40452,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featurestores$Entitytypes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -39449,8 +40916,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Featurestores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -39750,8 +41216,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Featurestores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -40227,8 +41692,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Hyperparametertuningjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -40528,8 +41992,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Hyperparametertuningjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -41001,8 +42464,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Indexendpoints$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -41302,8 +42764,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Indexendpoints$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -41775,8 +43236,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Indexes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -42076,8 +43536,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Indexes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -42394,33 +43853,29 @@ export namespace aiplatform_v1 { }; } - export class Resource$Metadatastores { + export class Resource$Memorybanks { context: APIRequestContext; - artifacts: Resource$Metadatastores$Artifacts; - contexts: Resource$Metadatastores$Contexts; - executions: Resource$Metadatastores$Executions; - operations: Resource$Metadatastores$Operations; + memories: Resource$Memorybanks$Memories; + operations: Resource$Memorybanks$Operations; constructor(context: APIRequestContext) { this.context = context; - this.artifacts = new Resource$Metadatastores$Artifacts(this.context); - this.contexts = new Resource$Metadatastores$Contexts(this.context); - this.executions = new Resource$Metadatastores$Executions(this.context); - this.operations = new Resource$Metadatastores$Operations(this.context); + this.memories = new Resource$Memorybanks$Memories(this.context); + this.operations = new Resource$Memorybanks$Operations(this.context); } } - export class Resource$Metadatastores$Artifacts { + export class Resource$Memorybanks$Memories { context: APIRequestContext; - operations: Resource$Metadatastores$Artifacts$Operations; + operations: Resource$Memorybanks$Memories$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Metadatastores$Artifacts$Operations( + this.operations = new Resource$Memorybanks$Memories$Operations( this.context ); } } - export class Resource$Metadatastores$Artifacts$Operations { + export class Resource$Memorybanks$Memories$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -42456,9 +43911,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.artifacts.operations.cancel({ + * const res = await aiplatform.memoryBanks.memories.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -42479,31 +43934,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Memorybanks$Memories$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, + params?: Params$Resource$Memorybanks$Memories$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Memorybanks$Memories$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Memorybanks$Memories$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, + params: Params$Resource$Memorybanks$Memories$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Metadatastores$Artifacts$Operations$Cancel + | Params$Resource$Memorybanks$Memories$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42519,13 +43974,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; + {}) as Params$Resource$Memorybanks$Memories$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; + params = {} as Params$Resource$Memorybanks$Memories$Operations$Cancel; options = {}; } @@ -42589,9 +44043,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.artifacts.operations.delete({ + * const res = await aiplatform.memoryBanks.memories.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -42612,31 +44066,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Memorybanks$Memories$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Metadatastores$Artifacts$Operations$Delete, + params?: Params$Resource$Memorybanks$Memories$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Memorybanks$Memories$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Memorybanks$Memories$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, + params: Params$Resource$Memorybanks$Memories$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Metadatastores$Artifacts$Operations$Delete + | Params$Resource$Memorybanks$Memories$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42652,13 +44106,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Artifacts$Operations$Delete; + {}) as Params$Resource$Memorybanks$Memories$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Artifacts$Operations$Delete; + params = {} as Params$Resource$Memorybanks$Memories$Operations$Delete; options = {}; } @@ -42722,9 +44175,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.artifacts.operations.get({ + * const res = await aiplatform.memoryBanks.memories.operations.get({ * // The name of the operation resource. - * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -42751,27 +44204,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Memorybanks$Memories$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Metadatastores$Artifacts$Operations$Get, + params?: Params$Resource$Memorybanks$Memories$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Memorybanks$Memories$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Memorybanks$Memories$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Artifacts$Operations$Get, + params: Params$Resource$Memorybanks$Memories$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -42779,7 +44231,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Metadatastores$Artifacts$Operations$Get + | Params$Resource$Memorybanks$Memories$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42795,12 +44247,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Artifacts$Operations$Get; + {}) as Params$Resource$Memorybanks$Memories$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Get; + params = {} as Params$Resource$Memorybanks$Memories$Operations$Get; options = {}; } @@ -42864,11 +44316,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.artifacts.operations.list({ + * const res = await aiplatform.memoryBanks.memories.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'metadataStores/my-metadataStore/artifacts/my-artifact', + * name: 'memoryBanks/my-memoryBank/memories/my-memorie', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -42899,29 +44351,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Memorybanks$Memories$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Metadatastores$Artifacts$Operations$List, + params?: Params$Resource$Memorybanks$Memories$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Memorybanks$Memories$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Memorybanks$Memories$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Artifacts$Operations$List, + params: Params$Resource$Memorybanks$Memories$Operations$List, callback: BodyResponseCallback ): void; list( @@ -42929,7 +44381,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Metadatastores$Artifacts$Operations$List + | Params$Resource$Memorybanks$Memories$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -42947,12 +44399,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Artifacts$Operations$List; + {}) as Params$Resource$Memorybanks$Memories$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Artifacts$Operations$List; + params = {} as Params$Resource$Memorybanks$Memories$Operations$List; options = {}; } @@ -43021,9 +44473,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.artifacts.operations.wait({ + * const res = await aiplatform.memoryBanks.memories.operations.wait({ * // The name of the operation resource to wait on. - * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -43052,27 +44504,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Memorybanks$Memories$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Metadatastores$Artifacts$Operations$Wait, + params?: Params$Resource$Memorybanks$Memories$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Memorybanks$Memories$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Memorybanks$Memories$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, + params: Params$Resource$Memorybanks$Memories$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -43080,7 +44531,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Metadatastores$Artifacts$Operations$Wait + | Params$Resource$Memorybanks$Memories$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43096,12 +44547,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Artifacts$Operations$Wait; + {}) as Params$Resource$Memorybanks$Memories$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Wait; + params = {} as Params$Resource$Memorybanks$Memories$Operations$Wait; options = {}; } @@ -43136,25 +44587,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Memorybanks$Memories$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { + export interface Params$Resource$Memorybanks$Memories$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Metadatastores$Artifacts$Operations$Get extends StandardParameters { + export interface Params$Resource$Memorybanks$Memories$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Metadatastores$Artifacts$Operations$List extends StandardParameters { + export interface Params$Resource$Memorybanks$Memories$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -43176,7 +44627,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { + export interface Params$Resource$Memorybanks$Memories$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -43187,18 +44638,7 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Metadatastores$Contexts { - context: APIRequestContext; - operations: Resource$Metadatastores$Contexts$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Metadatastores$Contexts$Operations( - this.context - ); - } - } - - export class Resource$Metadatastores$Contexts$Operations { + export class Resource$Memorybanks$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -43234,9 +44674,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.contexts.operations.cancel({ + * const res = await aiplatform.memoryBanks.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/operations/my-operation', * }); * console.log(res.data); * @@ -43257,31 +44697,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Memorybanks$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + params?: Params$Resource$Memorybanks$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Memorybanks$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Memorybanks$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Memorybanks$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Metadatastores$Contexts$Operations$Cancel + | Params$Resource$Memorybanks$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43297,13 +44737,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Contexts$Operations$Cancel; + {}) as Params$Resource$Memorybanks$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Contexts$Operations$Cancel; + params = {} as Params$Resource$Memorybanks$Operations$Cancel; options = {}; } @@ -43367,9 +44806,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.contexts.operations.delete({ + * const res = await aiplatform.memoryBanks.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/operations/my-operation', * }); * console.log(res.data); * @@ -43390,31 +44829,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Memorybanks$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Metadatastores$Contexts$Operations$Delete, + params?: Params$Resource$Memorybanks$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Memorybanks$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Memorybanks$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Memorybanks$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Metadatastores$Contexts$Operations$Delete + | Params$Resource$Memorybanks$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43430,13 +44869,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Contexts$Operations$Delete; + {}) as Params$Resource$Memorybanks$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Contexts$Operations$Delete; + params = {} as Params$Resource$Memorybanks$Operations$Delete; options = {}; } @@ -43500,9 +44938,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.contexts.operations.get({ + * const res = await aiplatform.memoryBanks.operations.get({ * // The name of the operation resource. - * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/operations/my-operation', * }); * console.log(res.data); * @@ -43529,27 +44967,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Memorybanks$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Metadatastores$Contexts$Operations$Get, + params?: Params$Resource$Memorybanks$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Memorybanks$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Memorybanks$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Memorybanks$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -43557,7 +44994,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Metadatastores$Contexts$Operations$Get + | Params$Resource$Memorybanks$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43573,12 +45010,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Contexts$Operations$Get; + {}) as Params$Resource$Memorybanks$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Contexts$Operations$Get; + params = {} as Params$Resource$Memorybanks$Operations$Get; options = {}; } @@ -43642,11 +45079,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.contexts.operations.list({ + * const res = await aiplatform.memoryBanks.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'metadataStores/my-metadataStore/contexts/my-context', + * name: 'memoryBanks/my-memoryBank', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -43677,29 +45114,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Memorybanks$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Metadatastores$Contexts$Operations$List, + params?: Params$Resource$Memorybanks$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Memorybanks$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Memorybanks$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Memorybanks$Operations$List, callback: BodyResponseCallback ): void; list( @@ -43707,7 +45144,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Metadatastores$Contexts$Operations$List + | Params$Resource$Memorybanks$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43725,12 +45162,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Contexts$Operations$List; + {}) as Params$Resource$Memorybanks$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Contexts$Operations$List; + params = {} as Params$Resource$Memorybanks$Operations$List; options = {}; } @@ -43799,9 +45236,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.contexts.operations.wait({ + * const res = await aiplatform.memoryBanks.operations.wait({ * // The name of the operation resource to wait on. - * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'memoryBanks/my-memoryBank/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -43830,27 +45267,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Memorybanks$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Metadatastores$Contexts$Operations$Wait, + params?: Params$Resource$Memorybanks$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Memorybanks$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Memorybanks$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Memorybanks$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -43858,7 +45294,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Metadatastores$Contexts$Operations$Wait + | Params$Resource$Memorybanks$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -43874,12 +45310,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Contexts$Operations$Wait; + {}) as Params$Resource$Memorybanks$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Contexts$Operations$Wait; + params = {} as Params$Resource$Memorybanks$Operations$Wait; options = {}; } @@ -43914,25 +45350,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Memorybanks$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Metadatastores$Contexts$Operations$Delete extends StandardParameters { + export interface Params$Resource$Memorybanks$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Metadatastores$Contexts$Operations$Get extends StandardParameters { + export interface Params$Resource$Memorybanks$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Metadatastores$Contexts$Operations$List extends StandardParameters { + export interface Params$Resource$Memorybanks$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -43954,7 +45390,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Metadatastores$Contexts$Operations$Wait extends StandardParameters { + export interface Params$Resource$Memorybanks$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -43965,18 +45401,33 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Metadatastores$Executions { + export class Resource$Metadatastores { context: APIRequestContext; - operations: Resource$Metadatastores$Executions$Operations; + artifacts: Resource$Metadatastores$Artifacts; + contexts: Resource$Metadatastores$Contexts; + executions: Resource$Metadatastores$Executions; + operations: Resource$Metadatastores$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Metadatastores$Executions$Operations( + this.artifacts = new Resource$Metadatastores$Artifacts(this.context); + this.contexts = new Resource$Metadatastores$Contexts(this.context); + this.executions = new Resource$Metadatastores$Executions(this.context); + this.operations = new Resource$Metadatastores$Operations(this.context); + } + } + + export class Resource$Metadatastores$Artifacts { + context: APIRequestContext; + operations: Resource$Metadatastores$Artifacts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Metadatastores$Artifacts$Operations( this.context ); } } - export class Resource$Metadatastores$Executions$Operations { + export class Resource$Metadatastores$Artifacts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -44012,9 +45463,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.executions.operations.cancel({ + * const res = await aiplatform.metadataStores.artifacts.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }); * console.log(res.data); * @@ -44035,31 +45486,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Metadatastores$Executions$Operations$Cancel, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Executions$Operations$Cancel, + params: Params$Resource$Metadatastores$Artifacts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Metadatastores$Executions$Operations$Cancel + | Params$Resource$Metadatastores$Artifacts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44075,13 +45526,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Executions$Operations$Cancel; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Metadatastores$Executions$Operations$Cancel; + {} as Params$Resource$Metadatastores$Artifacts$Operations$Cancel; options = {}; } @@ -44145,9 +45596,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.executions.operations.delete({ + * const res = await aiplatform.metadataStores.artifacts.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }); * console.log(res.data); * @@ -44168,31 +45619,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Metadatastores$Executions$Operations$Delete, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Executions$Operations$Delete, + params: Params$Resource$Metadatastores$Artifacts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Metadatastores$Executions$Operations$Delete + | Params$Resource$Metadatastores$Artifacts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44208,13 +45659,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Executions$Operations$Delete; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Metadatastores$Executions$Operations$Delete; + {} as Params$Resource$Metadatastores$Artifacts$Operations$Delete; options = {}; } @@ -44278,9 +45729,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.executions.operations.get({ + * const res = await aiplatform.metadataStores.artifacts.operations.get({ * // The name of the operation resource. - * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }); * console.log(res.data); * @@ -44307,27 +45758,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Metadatastores$Executions$Operations$Get, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Executions$Operations$Get, + params: Params$Resource$Metadatastores$Artifacts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -44335,7 +45785,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Metadatastores$Executions$Operations$Get + | Params$Resource$Metadatastores$Artifacts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44351,12 +45801,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Executions$Operations$Get; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Executions$Operations$Get; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Get; options = {}; } @@ -44420,11 +45870,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.executions.operations.list({ + * const res = await aiplatform.metadataStores.artifacts.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'metadataStores/my-metadataStore/executions/my-execution', + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -44455,29 +45905,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Metadatastores$Executions$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Metadatastores$Executions$Operations$List, + params?: Params$Resource$Metadatastores$Artifacts$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Metadatastores$Executions$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Executions$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Executions$Operations$List, + params: Params$Resource$Metadatastores$Artifacts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -44485,7 +45935,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Metadatastores$Executions$Operations$List + | Params$Resource$Metadatastores$Artifacts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44503,13 +45953,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Executions$Operations$List; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Executions$Operations$List; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$List; options = {}; } @@ -44578,9 +46027,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.executions.operations.wait({ + * const res = await aiplatform.metadataStores.artifacts.operations.wait({ * // The name of the operation resource to wait on. - * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * name: 'metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -44609,27 +46058,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Metadatastores$Executions$Operations$Wait, + params?: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Executions$Operations$Wait, + params: Params$Resource$Metadatastores$Artifacts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -44637,7 +46085,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Metadatastores$Executions$Operations$Wait + | Params$Resource$Metadatastores$Artifacts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44653,13 +46101,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Executions$Operations$Wait; + {}) as Params$Resource$Metadatastores$Artifacts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Metadatastores$Executions$Operations$Wait; + params = {} as Params$Resource$Metadatastores$Artifacts$Operations$Wait; options = {}; } @@ -44694,25 +46141,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Metadatastores$Executions$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Metadatastores$Executions$Operations$Delete extends StandardParameters { + export interface Params$Resource$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Metadatastores$Executions$Operations$Get extends StandardParameters { + export interface Params$Resource$Metadatastores$Artifacts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Metadatastores$Executions$Operations$List extends StandardParameters { + export interface Params$Resource$Metadatastores$Artifacts$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -44734,7 +46181,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Metadatastores$Executions$Operations$Wait extends StandardParameters { + export interface Params$Resource$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -44745,7 +46192,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Metadatastores$Operations { + export class Resource$Metadatastores$Contexts { + context: APIRequestContext; + operations: Resource$Metadatastores$Contexts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Metadatastores$Contexts$Operations( + this.context + ); + } + } + + export class Resource$Metadatastores$Contexts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -44781,9 +46239,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.operations.cancel({ + * const res = await aiplatform.metadataStores.contexts.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'metadataStores/my-metadataStore/operations/my-operation', + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * @@ -44804,31 +46262,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Metadatastores$Operations$Cancel, + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Metadatastores$Operations$Cancel, + params?: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Metadatastores$Operations$Cancel, + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Operations$Cancel, + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Metadatastores$Operations$Cancel, + params: Params$Resource$Metadatastores$Contexts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Metadatastores$Operations$Cancel + | Params$Resource$Metadatastores$Contexts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44844,12 +46302,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Operations$Cancel; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Operations$Cancel; + params = + {} as Params$Resource$Metadatastores$Contexts$Operations$Cancel; options = {}; } @@ -44913,9 +46372,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.operations.delete({ + * const res = await aiplatform.metadataStores.contexts.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'metadataStores/my-metadataStore/operations/my-operation', + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * @@ -44936,31 +46395,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Metadatastores$Operations$Delete, + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Metadatastores$Operations$Delete, + params?: Params$Resource$Metadatastores$Contexts$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Metadatastores$Operations$Delete, + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Operations$Delete, + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Metadatastores$Operations$Delete, + params: Params$Resource$Metadatastores$Contexts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Metadatastores$Operations$Delete + | Params$Resource$Metadatastores$Contexts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -44976,12 +46435,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Operations$Delete; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Operations$Delete; + params = + {} as Params$Resource$Metadatastores$Contexts$Operations$Delete; options = {}; } @@ -45045,9 +46505,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.operations.get({ + * const res = await aiplatform.metadataStores.contexts.operations.get({ * // The name of the operation resource. - * name: 'metadataStores/my-metadataStore/operations/my-operation', + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * }); * console.log(res.data); * @@ -45074,27 +46534,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Metadatastores$Operations$Get, + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Metadatastores$Operations$Get, + params?: Params$Resource$Metadatastores$Contexts$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Metadatastores$Operations$Get, + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Operations$Get, + params: Params$Resource$Metadatastores$Contexts$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Metadatastores$Operations$Get, + params: Params$Resource$Metadatastores$Contexts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -45102,7 +46561,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Metadatastores$Operations$Get + | Params$Resource$Metadatastores$Contexts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45118,12 +46577,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Operations$Get; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Operations$Get; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$Get; options = {}; } @@ -45187,11 +46646,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.operations.list({ + * const res = await aiplatform.metadataStores.contexts.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'metadataStores/my-metadataStore', + * name: 'metadataStores/my-metadataStore/contexts/my-context', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -45222,29 +46681,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Metadatastores$Operations$List, + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Metadatastores$Operations$List, + params?: Params$Resource$Metadatastores$Contexts$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Metadatastores$Operations$List, + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Operations$List, + params: Params$Resource$Metadatastores$Contexts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Metadatastores$Operations$List, + params: Params$Resource$Metadatastores$Contexts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -45252,7 +46711,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Metadatastores$Operations$List + | Params$Resource$Metadatastores$Contexts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45270,12 +46729,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Operations$List; + {}) as Params$Resource$Metadatastores$Contexts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Operations$List; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$List; options = {}; } @@ -45344,9 +46803,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.metadataStores.operations.wait({ + * const res = await aiplatform.metadataStores.contexts.operations.wait({ * // The name of the operation resource to wait on. - * name: 'metadataStores/my-metadataStore/operations/my-operation', + * name: 'metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -45375,27 +46834,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Metadatastores$Operations$Wait, + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Metadatastores$Operations$Wait, + params?: Params$Resource$Metadatastores$Contexts$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Metadatastores$Operations$Wait, + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Operations$Wait, + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Metadatastores$Operations$Wait, + params: Params$Resource$Metadatastores$Contexts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -45403,7 +46861,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Metadatastores$Operations$Wait + | Params$Resource$Metadatastores$Contexts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45419,12 +46877,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Metadatastores$Operations$Wait; + {}) as Params$Resource$Metadatastores$Contexts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Metadatastores$Operations$Wait; + params = {} as Params$Resource$Metadatastores$Contexts$Operations$Wait; options = {}; } @@ -45459,25 +46917,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Metadatastores$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Metadatastores$Operations$Delete extends StandardParameters { + export interface Params$Resource$Metadatastores$Contexts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Metadatastores$Operations$Get extends StandardParameters { + export interface Params$Resource$Metadatastores$Contexts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Metadatastores$Operations$List extends StandardParameters { + export interface Params$Resource$Metadatastores$Contexts$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -45499,7 +46957,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Metadatastores$Operations$Wait extends StandardParameters { + export interface Params$Resource$Metadatastores$Contexts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -45510,18 +46968,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Migratableresources { + export class Resource$Metadatastores$Executions { context: APIRequestContext; - operations: Resource$Migratableresources$Operations; + operations: Resource$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Migratableresources$Operations( + this.operations = new Resource$Metadatastores$Executions$Operations( this.context ); } } - export class Resource$Migratableresources$Operations { + export class Resource$Metadatastores$Executions$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -45557,9 +47015,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.migratableResources.operations.cancel({ + * const res = await aiplatform.metadataStores.executions.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'migratableResources/my-migratableResource/operations/my-operation', + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * @@ -45580,31 +47038,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Migratableresources$Operations$Cancel, + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Migratableresources$Operations$Cancel, + params?: Params$Resource$Metadatastores$Executions$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Migratableresources$Operations$Cancel, + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Migratableresources$Operations$Cancel, + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Migratableresources$Operations$Cancel, + params: Params$Resource$Metadatastores$Executions$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Migratableresources$Operations$Cancel + | Params$Resource$Metadatastores$Executions$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45620,12 +47078,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Migratableresources$Operations$Cancel; + {}) as Params$Resource$Metadatastores$Executions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Migratableresources$Operations$Cancel; + params = + {} as Params$Resource$Metadatastores$Executions$Operations$Cancel; options = {}; } @@ -45689,9 +47148,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.migratableResources.operations.delete({ + * const res = await aiplatform.metadataStores.executions.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'migratableResources/my-migratableResource/operations/my-operation', + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * @@ -45712,31 +47171,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Migratableresources$Operations$Delete, + params: Params$Resource$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Migratableresources$Operations$Delete, + params?: Params$Resource$Metadatastores$Executions$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Migratableresources$Operations$Delete, + params: Params$Resource$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Migratableresources$Operations$Delete, + params: Params$Resource$Metadatastores$Executions$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Migratableresources$Operations$Delete, + params: Params$Resource$Metadatastores$Executions$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Migratableresources$Operations$Delete + | Params$Resource$Metadatastores$Executions$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45752,12 +47211,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Migratableresources$Operations$Delete; + {}) as Params$Resource$Metadatastores$Executions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Migratableresources$Operations$Delete; + params = + {} as Params$Resource$Metadatastores$Executions$Operations$Delete; options = {}; } @@ -45821,9 +47281,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.migratableResources.operations.get({ + * const res = await aiplatform.metadataStores.executions.operations.get({ * // The name of the operation resource. - * name: 'migratableResources/my-migratableResource/operations/my-operation', + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * }); * console.log(res.data); * @@ -45850,27 +47310,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Migratableresources$Operations$Get, + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Migratableresources$Operations$Get, + params?: Params$Resource$Metadatastores$Executions$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Migratableresources$Operations$Get, + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Migratableresources$Operations$Get, + params: Params$Resource$Metadatastores$Executions$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Migratableresources$Operations$Get, + params: Params$Resource$Metadatastores$Executions$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -45878,7 +47337,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Migratableresources$Operations$Get + | Params$Resource$Metadatastores$Executions$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -45894,12 +47353,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Migratableresources$Operations$Get; + {}) as Params$Resource$Metadatastores$Executions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Migratableresources$Operations$Get; + params = {} as Params$Resource$Metadatastores$Executions$Operations$Get; options = {}; } @@ -45963,11 +47422,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.migratableResources.operations.list({ + * const res = await aiplatform.metadataStores.executions.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'migratableResources/my-migratableResource', + * name: 'metadataStores/my-metadataStore/executions/my-execution', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -45998,29 +47457,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Migratableresources$Operations$List, + params: Params$Resource$Metadatastores$Executions$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Migratableresources$Operations$List, + params?: Params$Resource$Metadatastores$Executions$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Migratableresources$Operations$List, + params: Params$Resource$Metadatastores$Executions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Migratableresources$Operations$List, + params: Params$Resource$Metadatastores$Executions$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Migratableresources$Operations$List, + params: Params$Resource$Metadatastores$Executions$Operations$List, callback: BodyResponseCallback ): void; list( @@ -46028,7 +47487,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Migratableresources$Operations$List + | Params$Resource$Metadatastores$Executions$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46046,12 +47505,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Migratableresources$Operations$List; + {}) as Params$Resource$Metadatastores$Executions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Migratableresources$Operations$List; + params = + {} as Params$Resource$Metadatastores$Executions$Operations$List; options = {}; } @@ -46120,9 +47580,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.migratableResources.operations.wait({ + * const res = await aiplatform.metadataStores.executions.operations.wait({ * // The name of the operation resource to wait on. - * name: 'migratableResources/my-migratableResource/operations/my-operation', + * name: 'metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -46151,27 +47611,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Migratableresources$Operations$Wait, + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Migratableresources$Operations$Wait, + params?: Params$Resource$Metadatastores$Executions$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Migratableresources$Operations$Wait, + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Migratableresources$Operations$Wait, + params: Params$Resource$Metadatastores$Executions$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Migratableresources$Operations$Wait, + params: Params$Resource$Metadatastores$Executions$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -46179,7 +47638,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Migratableresources$Operations$Wait + | Params$Resource$Metadatastores$Executions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46195,12 +47654,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Migratableresources$Operations$Wait; + {}) as Params$Resource$Metadatastores$Executions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Migratableresources$Operations$Wait; + params = + {} as Params$Resource$Metadatastores$Executions$Operations$Wait; options = {}; } @@ -46235,25 +47695,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Migratableresources$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Metadatastores$Executions$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Migratableresources$Operations$Delete extends StandardParameters { + export interface Params$Resource$Metadatastores$Executions$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Migratableresources$Operations$Get extends StandardParameters { + export interface Params$Resource$Metadatastores$Executions$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Migratableresources$Operations$List extends StandardParameters { + export interface Params$Resource$Metadatastores$Executions$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -46275,7 +47735,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Migratableresources$Operations$Wait extends StandardParameters { + export interface Params$Resource$Metadatastores$Executions$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -46286,18 +47746,7 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Modeldeploymentmonitoringjobs { - context: APIRequestContext; - operations: Resource$Modeldeploymentmonitoringjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Modeldeploymentmonitoringjobs$Operations( - this.context - ); - } - } - - export class Resource$Modeldeploymentmonitoringjobs$Operations { + export class Resource$Metadatastores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -46333,9 +47782,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.cancel({ + * const res = await aiplatform.metadataStores.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * @@ -46356,31 +47805,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Metadatastores$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + params?: Params$Resource$Metadatastores$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Metadatastores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Metadatastores$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Metadatastores$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel + | Params$Resource$Metadatastores$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46396,13 +47845,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; + {}) as Params$Resource$Metadatastores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; + params = {} as Params$Resource$Metadatastores$Operations$Cancel; options = {}; } @@ -46466,9 +47914,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.delete({ + * const res = await aiplatform.metadataStores.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * @@ -46489,31 +47937,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Metadatastores$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + params?: Params$Resource$Metadatastores$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Metadatastores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Metadatastores$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Metadatastores$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete + | Params$Resource$Metadatastores$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46529,13 +47977,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; + {}) as Params$Resource$Metadatastores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; + params = {} as Params$Resource$Metadatastores$Operations$Delete; options = {}; } @@ -46599,9 +48046,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.get({ + * const res = await aiplatform.metadataStores.operations.get({ * // The name of the operation resource. - * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * @@ -46628,27 +48075,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Metadatastores$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, + params?: Params$Resource$Metadatastores$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Metadatastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Metadatastores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Metadatastores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -46656,7 +48102,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get + | Params$Resource$Metadatastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46672,13 +48118,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; + {}) as Params$Resource$Metadatastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; + params = {} as Params$Resource$Metadatastores$Operations$Get; options = {}; } @@ -46742,11 +48187,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.list({ + * const res = await aiplatform.metadataStores.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * name: 'metadataStores/my-metadataStore', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -46777,29 +48222,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Metadatastores$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + params?: Params$Resource$Metadatastores$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Metadatastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Metadatastores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Metadatastores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -46807,7 +48252,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Modeldeploymentmonitoringjobs$Operations$List + | Params$Resource$Metadatastores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46825,13 +48270,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; + {}) as Params$Resource$Metadatastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; + params = {} as Params$Resource$Metadatastores$Operations$List; options = {}; } @@ -46900,9 +48344,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.wait({ + * const res = await aiplatform.metadataStores.operations.wait({ * // The name of the operation resource to wait on. - * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'metadataStores/my-metadataStore/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -46931,27 +48375,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Metadatastores$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + params?: Params$Resource$Metadatastores$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Metadatastores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Metadatastores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Metadatastores$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -46959,7 +48402,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait + | Params$Resource$Metadatastores$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -46975,13 +48418,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; + {}) as Params$Resource$Metadatastores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; + params = {} as Params$Resource$Metadatastores$Operations$Wait; options = {}; } @@ -47016,25 +48458,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Metadatastores$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Metadatastores$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Metadatastores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Metadatastores$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -47056,7 +48498,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Metadatastores$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -47067,29 +48509,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Models { - context: APIRequestContext; - evaluations: Resource$Models$Evaluations; - operations: Resource$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.evaluations = new Resource$Models$Evaluations(this.context); - this.operations = new Resource$Models$Operations(this.context); - } - } - - export class Resource$Models$Evaluations { + export class Resource$Migratableresources { context: APIRequestContext; - operations: Resource$Models$Evaluations$Operations; + operations: Resource$Migratableresources$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Models$Evaluations$Operations( + this.operations = new Resource$Migratableresources$Operations( this.context ); } } - export class Resource$Models$Evaluations$Operations { + export class Resource$Migratableresources$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -47125,9 +48556,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.evaluations.operations.cancel({ + * const res = await aiplatform.migratableResources.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'migratableResources/my-migratableResource/operations/my-operation', * }); * console.log(res.data); * @@ -47148,31 +48579,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Migratableresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Models$Evaluations$Operations$Cancel, + params?: Params$Resource$Migratableresources$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Migratableresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Migratableresources$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Migratableresources$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Models$Evaluations$Operations$Cancel + | Params$Resource$Migratableresources$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47188,12 +48619,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Evaluations$Operations$Cancel; + {}) as Params$Resource$Migratableresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Evaluations$Operations$Cancel; + params = {} as Params$Resource$Migratableresources$Operations$Cancel; options = {}; } @@ -47257,9 +48688,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.evaluations.operations.delete({ + * const res = await aiplatform.migratableResources.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'migratableResources/my-migratableResource/operations/my-operation', * }); * console.log(res.data); * @@ -47280,31 +48711,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Models$Evaluations$Operations$Delete, + params: Params$Resource$Migratableresources$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Models$Evaluations$Operations$Delete, + params?: Params$Resource$Migratableresources$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Models$Evaluations$Operations$Delete, + params: Params$Resource$Migratableresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Models$Evaluations$Operations$Delete, + params: Params$Resource$Migratableresources$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Models$Evaluations$Operations$Delete, + params: Params$Resource$Migratableresources$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Models$Evaluations$Operations$Delete + | Params$Resource$Migratableresources$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47320,12 +48751,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Evaluations$Operations$Delete; + {}) as Params$Resource$Migratableresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Evaluations$Operations$Delete; + params = {} as Params$Resource$Migratableresources$Operations$Delete; options = {}; } @@ -47389,9 +48820,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.evaluations.operations.get({ + * const res = await aiplatform.migratableResources.operations.get({ * // The name of the operation resource. - * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'migratableResources/my-migratableResource/operations/my-operation', * }); * console.log(res.data); * @@ -47418,27 +48849,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Models$Evaluations$Operations$Get, + params: Params$Resource$Migratableresources$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Models$Evaluations$Operations$Get, + params?: Params$Resource$Migratableresources$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Models$Evaluations$Operations$Get, + params: Params$Resource$Migratableresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Models$Evaluations$Operations$Get, + params: Params$Resource$Migratableresources$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Models$Evaluations$Operations$Get, + params: Params$Resource$Migratableresources$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -47446,7 +48876,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Models$Evaluations$Operations$Get + | Params$Resource$Migratableresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47462,12 +48892,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Evaluations$Operations$Get; + {}) as Params$Resource$Migratableresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Evaluations$Operations$Get; + params = {} as Params$Resource$Migratableresources$Operations$Get; options = {}; } @@ -47531,11 +48961,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.evaluations.operations.list({ + * const res = await aiplatform.migratableResources.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'models/my-model/evaluations/my-evaluation', + * name: 'migratableResources/my-migratableResource', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -47566,29 +48996,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Models$Evaluations$Operations$List, + params: Params$Resource$Migratableresources$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Models$Evaluations$Operations$List, + params?: Params$Resource$Migratableresources$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Models$Evaluations$Operations$List, + params: Params$Resource$Migratableresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Models$Evaluations$Operations$List, + params: Params$Resource$Migratableresources$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Models$Evaluations$Operations$List, + params: Params$Resource$Migratableresources$Operations$List, callback: BodyResponseCallback ): void; list( @@ -47596,7 +49026,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Models$Evaluations$Operations$List + | Params$Resource$Migratableresources$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47614,12 +49044,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Evaluations$Operations$List; + {}) as Params$Resource$Migratableresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Evaluations$Operations$List; + params = {} as Params$Resource$Migratableresources$Operations$List; options = {}; } @@ -47688,9 +49118,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.evaluations.operations.wait({ + * const res = await aiplatform.migratableResources.operations.wait({ * // The name of the operation resource to wait on. - * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', + * name: 'migratableResources/my-migratableResource/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -47719,27 +49149,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Models$Evaluations$Operations$Wait, + params: Params$Resource$Migratableresources$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Models$Evaluations$Operations$Wait, + params?: Params$Resource$Migratableresources$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Models$Evaluations$Operations$Wait, + params: Params$Resource$Migratableresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Models$Evaluations$Operations$Wait, + params: Params$Resource$Migratableresources$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Models$Evaluations$Operations$Wait, + params: Params$Resource$Migratableresources$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -47747,7 +49176,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Models$Evaluations$Operations$Wait + | Params$Resource$Migratableresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47763,12 +49192,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Evaluations$Operations$Wait; + {}) as Params$Resource$Migratableresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Evaluations$Operations$Wait; + params = {} as Params$Resource$Migratableresources$Operations$Wait; options = {}; } @@ -47803,25 +49232,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Models$Evaluations$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Migratableresources$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Models$Evaluations$Operations$Delete extends StandardParameters { + export interface Params$Resource$Migratableresources$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Models$Evaluations$Operations$Get extends StandardParameters { + export interface Params$Resource$Migratableresources$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Models$Evaluations$Operations$List extends StandardParameters { + export interface Params$Resource$Migratableresources$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -47843,7 +49272,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Models$Evaluations$Operations$Wait extends StandardParameters { + export interface Params$Resource$Migratableresources$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -47854,7 +49283,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Models$Operations { + export class Resource$Modeldeploymentmonitoringjobs { + context: APIRequestContext; + operations: Resource$Modeldeploymentmonitoringjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Modeldeploymentmonitoringjobs$Operations( + this.context + ); + } + } + + export class Resource$Modeldeploymentmonitoringjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -47890,9 +49330,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.operations.cancel({ + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'models/my-model/operations/my-operation', + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }); * console.log(res.data); * @@ -47913,31 +49353,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Models$Operations$Cancel, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Models$Operations$Cancel, + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Models$Operations$Cancel, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Models$Operations$Cancel, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Models$Operations$Cancel, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Models$Operations$Cancel + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -47953,12 +49393,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Operations$Cancel; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Operations$Cancel; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel; options = {}; } @@ -48022,9 +49463,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.operations.delete({ + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'models/my-model/operations/my-operation', + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }); * console.log(res.data); * @@ -48045,31 +49486,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Models$Operations$Delete, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Models$Operations$Delete, + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Models$Operations$Delete, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Models$Operations$Delete, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Models$Operations$Delete, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Models$Operations$Delete + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48085,12 +49526,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Operations$Delete; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Operations$Delete; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete; options = {}; } @@ -48154,9 +49596,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.operations.get({ + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.get({ * // The name of the operation resource. - * name: 'models/my-model/operations/my-operation', + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }); * console.log(res.data); * @@ -48183,27 +49625,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Models$Operations$Get, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Models$Operations$Get, + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Models$Operations$Get, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Models$Operations$Get, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Models$Operations$Get, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -48211,7 +49652,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Models$Operations$Get + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48227,12 +49668,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Operations$Get; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Operations$Get; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get; options = {}; } @@ -48296,11 +49738,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.operations.list({ + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'models/my-model', + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -48331,29 +49773,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Models$Operations$List, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Models$Operations$List, + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Models$Operations$List, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Models$Operations$List, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Models$Operations$List, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -48361,7 +49803,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Models$Operations$List + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48379,12 +49821,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Operations$List; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Operations$List; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$List; options = {}; } @@ -48453,9 +49896,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.models.operations.wait({ + * const res = await aiplatform.modelDeploymentMonitoringJobs.operations.wait({ * // The name of the operation resource to wait on. - * name: 'models/my-model/operations/my-operation', + * name: 'modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -48484,27 +49927,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Models$Operations$Wait, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Models$Operations$Wait, + params?: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Models$Operations$Wait, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Models$Operations$Wait, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Models$Operations$Wait, + params: Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -48512,7 +49954,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Models$Operations$Wait + | Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48528,12 +49970,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Models$Operations$Wait; + {}) as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Models$Operations$Wait; + params = + {} as Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait; options = {}; } @@ -48568,25 +50011,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Models$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Models$Operations$Delete extends StandardParameters { + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Models$Operations$Get extends StandardParameters { + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Models$Operations$List extends StandardParameters { + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -48608,7 +50051,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Models$Operations$Wait extends StandardParameters { + export interface Params$Resource$Modeldeploymentmonitoringjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -48619,18 +50062,29 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Notebookexecutionjobs { + export class Resource$Models { context: APIRequestContext; - operations: Resource$Notebookexecutionjobs$Operations; + evaluations: Resource$Models$Evaluations; + operations: Resource$Models$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Notebookexecutionjobs$Operations( + this.evaluations = new Resource$Models$Evaluations(this.context); + this.operations = new Resource$Models$Operations(this.context); + } + } + + export class Resource$Models$Evaluations { + context: APIRequestContext; + operations: Resource$Models$Evaluations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Models$Evaluations$Operations( this.context ); } } - export class Resource$Notebookexecutionjobs$Operations { + export class Resource$Models$Evaluations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -48666,9 +50120,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookExecutionJobs.operations.cancel({ + * const res = await aiplatform.models.evaluations.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -48689,31 +50143,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Notebookexecutionjobs$Operations$Cancel, + params?: Params$Resource$Models$Evaluations$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, + params: Params$Resource$Models$Evaluations$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Notebookexecutionjobs$Operations$Cancel + | Params$Resource$Models$Evaluations$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48729,12 +50183,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookexecutionjobs$Operations$Cancel; + {}) as Params$Resource$Models$Evaluations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookexecutionjobs$Operations$Cancel; + params = {} as Params$Resource$Models$Evaluations$Operations$Cancel; options = {}; } @@ -48798,9 +50252,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookExecutionJobs.operations.delete({ + * const res = await aiplatform.models.evaluations.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -48821,31 +50275,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Notebookexecutionjobs$Operations$Delete, + params?: Params$Resource$Models$Evaluations$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Models$Evaluations$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Notebookexecutionjobs$Operations$Delete + | Params$Resource$Models$Evaluations$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -48861,12 +50315,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookexecutionjobs$Operations$Delete; + {}) as Params$Resource$Models$Evaluations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookexecutionjobs$Operations$Delete; + params = {} as Params$Resource$Models$Evaluations$Operations$Delete; options = {}; } @@ -48930,9 +50384,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookExecutionJobs.operations.get({ + * const res = await aiplatform.models.evaluations.operations.get({ * // The name of the operation resource. - * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -48959,27 +50413,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Notebookexecutionjobs$Operations$Get, + params?: Params$Resource$Models$Evaluations$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Models$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -48987,7 +50440,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Notebookexecutionjobs$Operations$Get + | Params$Resource$Models$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49003,12 +50456,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookexecutionjobs$Operations$Get; + {}) as Params$Resource$Models$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookexecutionjobs$Operations$Get; + params = {} as Params$Resource$Models$Evaluations$Operations$Get; options = {}; } @@ -49072,11 +50525,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookExecutionJobs.operations.list({ + * const res = await aiplatform.models.evaluations.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'notebookExecutionJobs/my-notebookExecutionJob', + * name: 'models/my-model/evaluations/my-evaluation', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -49107,29 +50560,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Notebookexecutionjobs$Operations$List, + params?: Params$Resource$Models$Evaluations$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Models$Evaluations$Operations$List, callback: BodyResponseCallback ): void; list( @@ -49137,7 +50590,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Notebookexecutionjobs$Operations$List + | Params$Resource$Models$Evaluations$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49155,12 +50608,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookexecutionjobs$Operations$List; + {}) as Params$Resource$Models$Evaluations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookexecutionjobs$Operations$List; + params = {} as Params$Resource$Models$Evaluations$Operations$List; options = {}; } @@ -49229,9 +50682,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookExecutionJobs.operations.wait({ + * const res = await aiplatform.models.evaluations.operations.wait({ * // The name of the operation resource to wait on. - * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * name: 'models/my-model/evaluations/my-evaluation/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -49260,27 +50713,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Notebookexecutionjobs$Operations$Wait, + params?: Params$Resource$Models$Evaluations$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookexecutionjobs$Operations$Wait, + params: Params$Resource$Models$Evaluations$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -49288,7 +50740,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Notebookexecutionjobs$Operations$Wait + | Params$Resource$Models$Evaluations$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49304,12 +50756,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookexecutionjobs$Operations$Wait; + {}) as Params$Resource$Models$Evaluations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookexecutionjobs$Operations$Wait; + params = {} as Params$Resource$Models$Evaluations$Operations$Wait; options = {}; } @@ -49344,25 +50796,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Models$Evaluations$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Notebookexecutionjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Models$Evaluations$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Notebookexecutionjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Models$Evaluations$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Notebookexecutionjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Models$Evaluations$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -49384,7 +50836,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Notebookexecutionjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Models$Evaluations$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -49395,16 +50847,7 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Notebookruntimes { - context: APIRequestContext; - operations: Resource$Notebookruntimes$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Notebookruntimes$Operations(this.context); - } - } - - export class Resource$Notebookruntimes$Operations { + export class Resource$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -49440,9 +50883,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimes.operations.cancel({ + * const res = await aiplatform.models.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * @@ -49463,31 +50906,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Models$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Notebookruntimes$Operations$Cancel, + params?: Params$Resource$Models$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Models$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Models$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Models$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Notebookruntimes$Operations$Cancel + | Params$Resource$Models$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49503,12 +50946,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimes$Operations$Cancel; + {}) as Params$Resource$Models$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimes$Operations$Cancel; + params = {} as Params$Resource$Models$Operations$Cancel; options = {}; } @@ -49572,9 +51015,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimes.operations.delete({ + * const res = await aiplatform.models.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * @@ -49595,31 +51038,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Notebookruntimes$Operations$Delete, + params: Params$Resource$Models$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Notebookruntimes$Operations$Delete, + params?: Params$Resource$Models$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Notebookruntimes$Operations$Delete, + params: Params$Resource$Models$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookruntimes$Operations$Delete, + params: Params$Resource$Models$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookruntimes$Operations$Delete, + params: Params$Resource$Models$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Notebookruntimes$Operations$Delete + | Params$Resource$Models$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49635,12 +51078,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimes$Operations$Delete; + {}) as Params$Resource$Models$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimes$Operations$Delete; + params = {} as Params$Resource$Models$Operations$Delete; options = {}; } @@ -49704,9 +51147,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimes.operations.get({ + * const res = await aiplatform.models.operations.get({ * // The name of the operation resource. - * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', + * name: 'models/my-model/operations/my-operation', * }); * console.log(res.data); * @@ -49733,27 +51176,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Notebookruntimes$Operations$Get, + params: Params$Resource$Models$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Notebookruntimes$Operations$Get, + params?: Params$Resource$Models$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Notebookruntimes$Operations$Get, + params: Params$Resource$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookruntimes$Operations$Get, + params: Params$Resource$Models$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookruntimes$Operations$Get, + params: Params$Resource$Models$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -49761,7 +51203,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Notebookruntimes$Operations$Get + | Params$Resource$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49777,12 +51219,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimes$Operations$Get; + {}) as Params$Resource$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimes$Operations$Get; + params = {} as Params$Resource$Models$Operations$Get; options = {}; } @@ -49846,11 +51288,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimes.operations.list({ + * const res = await aiplatform.models.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'notebookRuntimes/my-notebookRuntime', + * name: 'models/my-model', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -49881,29 +51323,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Notebookruntimes$Operations$List, + params: Params$Resource$Models$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Notebookruntimes$Operations$List, + params?: Params$Resource$Models$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Notebookruntimes$Operations$List, + params: Params$Resource$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookruntimes$Operations$List, + params: Params$Resource$Models$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookruntimes$Operations$List, + params: Params$Resource$Models$Operations$List, callback: BodyResponseCallback ): void; list( @@ -49911,7 +51353,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Notebookruntimes$Operations$List + | Params$Resource$Models$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -49929,12 +51371,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimes$Operations$List; + {}) as Params$Resource$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimes$Operations$List; + params = {} as Params$Resource$Models$Operations$List; options = {}; } @@ -50003,9 +51445,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimes.operations.wait({ + * const res = await aiplatform.models.operations.wait({ * // The name of the operation resource to wait on. - * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', + * name: 'models/my-model/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -50034,27 +51476,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Notebookruntimes$Operations$Wait, + params: Params$Resource$Models$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Notebookruntimes$Operations$Wait, + params?: Params$Resource$Models$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Notebookruntimes$Operations$Wait, + params: Params$Resource$Models$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookruntimes$Operations$Wait, + params: Params$Resource$Models$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookruntimes$Operations$Wait, + params: Params$Resource$Models$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -50062,7 +51503,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Notebookruntimes$Operations$Wait + | Params$Resource$Models$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50078,12 +51519,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimes$Operations$Wait; + {}) as Params$Resource$Models$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimes$Operations$Wait; + params = {} as Params$Resource$Models$Operations$Wait; options = {}; } @@ -50118,25 +51559,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Notebookruntimes$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Models$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Notebookruntimes$Operations$Delete extends StandardParameters { + export interface Params$Resource$Models$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Notebookruntimes$Operations$Get extends StandardParameters { + export interface Params$Resource$Models$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Notebookruntimes$Operations$List extends StandardParameters { + export interface Params$Resource$Models$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -50158,7 +51599,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Notebookruntimes$Operations$Wait extends StandardParameters { + export interface Params$Resource$Models$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -50169,18 +51610,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Notebookruntimetemplates { + export class Resource$Notebookexecutionjobs { context: APIRequestContext; - operations: Resource$Notebookruntimetemplates$Operations; + operations: Resource$Notebookexecutionjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Notebookruntimetemplates$Operations( + this.operations = new Resource$Notebookexecutionjobs$Operations( this.context ); } } - export class Resource$Notebookruntimetemplates$Operations { + export class Resource$Notebookexecutionjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -50216,9 +51657,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimeTemplates.operations.cancel({ + * const res = await aiplatform.notebookExecutionJobs.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * @@ -50239,31 +51680,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + params?: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, + params: Params$Resource$Notebookexecutionjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Notebookruntimetemplates$Operations$Cancel + | Params$Resource$Notebookexecutionjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50279,13 +51720,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimetemplates$Operations$Cancel; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Notebookruntimetemplates$Operations$Cancel; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Cancel; options = {}; } @@ -50349,9 +51789,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimeTemplates.operations.delete({ + * const res = await aiplatform.notebookExecutionJobs.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * @@ -50372,31 +51812,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Notebookruntimetemplates$Operations$Delete, + params?: Params$Resource$Notebookexecutionjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Notebookruntimetemplates$Operations$Delete, + params: Params$Resource$Notebookexecutionjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Notebookruntimetemplates$Operations$Delete + | Params$Resource$Notebookexecutionjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50412,13 +51852,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimetemplates$Operations$Delete; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Notebookruntimetemplates$Operations$Delete; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Delete; options = {}; } @@ -50482,9 +51921,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimeTemplates.operations.get({ + * const res = await aiplatform.notebookExecutionJobs.operations.get({ * // The name of the operation resource. - * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }); * console.log(res.data); * @@ -50511,27 +51950,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Notebookruntimetemplates$Operations$Get, + params?: Params$Resource$Notebookexecutionjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Notebookexecutionjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Notebookruntimetemplates$Operations$Get, + params: Params$Resource$Notebookexecutionjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -50539,7 +51977,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Notebookruntimetemplates$Operations$Get + | Params$Resource$Notebookexecutionjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50555,12 +51993,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimetemplates$Operations$Get; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimetemplates$Operations$Get; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Get; options = {}; } @@ -50624,11 +52062,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimeTemplates.operations.list({ + * const res = await aiplatform.notebookExecutionJobs.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * name: 'notebookExecutionJobs/my-notebookExecutionJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -50659,29 +52097,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Notebookruntimetemplates$Operations$List, + params?: Params$Resource$Notebookexecutionjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Notebookexecutionjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Notebookruntimetemplates$Operations$List, + params: Params$Resource$Notebookexecutionjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -50689,7 +52127,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Notebookruntimetemplates$Operations$List + | Params$Resource$Notebookexecutionjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50707,12 +52145,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimetemplates$Operations$List; + {}) as Params$Resource$Notebookexecutionjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimetemplates$Operations$List; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$List; options = {}; } @@ -50781,9 +52219,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.notebookRuntimeTemplates.operations.wait({ + * const res = await aiplatform.notebookExecutionJobs.operations.wait({ * // The name of the operation resource to wait on. - * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * name: 'notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -50812,27 +52250,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Notebookruntimetemplates$Operations$Wait, + params?: Params$Resource$Notebookexecutionjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Notebookruntimetemplates$Operations$Wait, + params: Params$Resource$Notebookexecutionjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -50840,7 +52277,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Notebookruntimetemplates$Operations$Wait + | Params$Resource$Notebookexecutionjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -50856,12 +52293,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Notebookruntimetemplates$Operations$Wait; + {}) as Params$Resource$Notebookexecutionjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Notebookruntimetemplates$Operations$Wait; + params = {} as Params$Resource$Notebookexecutionjobs$Operations$Wait; options = {}; } @@ -50896,25 +52333,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Notebookruntimetemplates$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Notebookruntimetemplates$Operations$Delete extends StandardParameters { + export interface Params$Resource$Notebookexecutionjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Notebookruntimetemplates$Operations$Get extends StandardParameters { + export interface Params$Resource$Notebookexecutionjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Notebookruntimetemplates$Operations$List extends StandardParameters { + export interface Params$Resource$Notebookexecutionjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -50936,7 +52373,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Notebookruntimetemplates$Operations$Wait extends StandardParameters { + export interface Params$Resource$Notebookexecutionjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -50947,7 +52384,16 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Operations { + export class Resource$Notebookruntimes { + context: APIRequestContext; + operations: Resource$Notebookruntimes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Notebookruntimes$Operations(this.context); + } + } + + export class Resource$Notebookruntimes$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -50983,9 +52429,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.operations.cancel({ + * const res = await aiplatform.notebookRuntimes.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'operations/my-operation', + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * @@ -51006,31 +52452,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Operations$Cancel, + params: Params$Resource$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Operations$Cancel, + params?: Params$Resource$Notebookruntimes$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Operations$Cancel, + params: Params$Resource$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Operations$Cancel, + params: Params$Resource$Notebookruntimes$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Operations$Cancel, + params: Params$Resource$Notebookruntimes$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Operations$Cancel + | Params$Resource$Notebookruntimes$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51046,12 +52492,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Operations$Cancel; + {}) as Params$Resource$Notebookruntimes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Cancel; + params = {} as Params$Resource$Notebookruntimes$Operations$Cancel; options = {}; } @@ -51115,9 +52561,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.operations.delete({ + * const res = await aiplatform.notebookRuntimes.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'operations/my-operation', + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * @@ -51138,31 +52584,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Operations$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Operations$Delete, + params?: Params$Resource$Notebookruntimes$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Operations$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Operations$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Operations$Delete, + params: Params$Resource$Notebookruntimes$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Operations$Delete + | Params$Resource$Notebookruntimes$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51178,12 +52624,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Operations$Delete; + {}) as Params$Resource$Notebookruntimes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Delete; + params = {} as Params$Resource$Notebookruntimes$Operations$Delete; options = {}; } @@ -51247,9 +52693,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.operations.get({ + * const res = await aiplatform.notebookRuntimes.operations.get({ * // The name of the operation resource. - * name: 'operations/my-operation', + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * }); * console.log(res.data); * @@ -51276,27 +52722,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Operations$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Operations$Get, + params?: Params$Resource$Notebookruntimes$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Operations$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Operations$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Operations$Get, + params: Params$Resource$Notebookruntimes$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -51304,7 +52749,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Operations$Get + | Params$Resource$Notebookruntimes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51319,12 +52764,13 @@ export namespace aiplatform_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Notebookruntimes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Get; + params = {} as Params$Resource$Notebookruntimes$Operations$Get; options = {}; } @@ -51388,11 +52834,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.operations.list({ + * const res = await aiplatform.notebookRuntimes.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'placeholder-value', + * name: 'notebookRuntimes/my-notebookRuntime', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -51423,29 +52869,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Operations$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Operations$List, + params?: Params$Resource$Notebookruntimes$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Operations$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Operations$List, + params: Params$Resource$Notebookruntimes$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Operations$List, + params: Params$Resource$Notebookruntimes$Operations$List, callback: BodyResponseCallback ): void; list( @@ -51453,7 +52899,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Operations$List + | Params$Resource$Notebookruntimes$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51470,12 +52916,13 @@ export namespace aiplatform_v1 { GaxiosResponseWithHTTP2 > | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let params = (paramsOrCallback || + {}) as Params$Resource$Notebookruntimes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$List; + params = {} as Params$Resource$Notebookruntimes$Operations$List; options = {}; } @@ -51488,15 +52935,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -51541,9 +52991,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.operations.wait({ + * const res = await aiplatform.notebookRuntimes.operations.wait({ * // The name of the operation resource to wait on. - * name: 'operations/my-operation', + * name: 'notebookRuntimes/my-notebookRuntime/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -51572,27 +53022,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Operations$Wait, + params: Params$Resource$Notebookruntimes$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Operations$Wait, + params?: Params$Resource$Notebookruntimes$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Operations$Wait, + params: Params$Resource$Notebookruntimes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Operations$Wait, + params: Params$Resource$Notebookruntimes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Operations$Wait, + params: Params$Resource$Notebookruntimes$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -51600,7 +53049,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Operations$Wait + | Params$Resource$Notebookruntimes$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51615,12 +53064,13 @@ export namespace aiplatform_v1 { | void | Promise> | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Operations$Wait; + let params = (paramsOrCallback || + {}) as Params$Resource$Notebookruntimes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Operations$Wait; + params = {} as Params$Resource$Notebookruntimes$Operations$Wait; options = {}; } @@ -51655,25 +53105,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Notebookruntimes$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Operations$Delete extends StandardParameters { + export interface Params$Resource$Notebookruntimes$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Operations$Get extends StandardParameters { + export interface Params$Resource$Notebookruntimes$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Operations$List extends StandardParameters { + export interface Params$Resource$Notebookruntimes$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -51695,7 +53145,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Operations$Wait extends StandardParameters { + export interface Params$Resource$Notebookruntimes$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -51706,18 +53156,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Persistentresources { + export class Resource$Notebookruntimetemplates { context: APIRequestContext; - operations: Resource$Persistentresources$Operations; + operations: Resource$Notebookruntimetemplates$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Persistentresources$Operations( + this.operations = new Resource$Notebookruntimetemplates$Operations( this.context ); } } - export class Resource$Persistentresources$Operations { + export class Resource$Notebookruntimetemplates$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -51753,9 +53203,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.persistentResources.operations.cancel({ + * const res = await aiplatform.notebookRuntimeTemplates.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'persistentResources/my-persistentResource/operations/my-operation', + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * @@ -51776,31 +53226,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Persistentresources$Operations$Cancel, + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Persistentresources$Operations$Cancel, + params?: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Persistentresources$Operations$Cancel, + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Persistentresources$Operations$Cancel, + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Persistentresources$Operations$Cancel, + params: Params$Resource$Notebookruntimetemplates$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Persistentresources$Operations$Cancel + | Params$Resource$Notebookruntimetemplates$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51816,12 +53266,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Persistentresources$Operations$Cancel; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Persistentresources$Operations$Cancel; + params = + {} as Params$Resource$Notebookruntimetemplates$Operations$Cancel; options = {}; } @@ -51885,9 +53336,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.persistentResources.operations.delete({ + * const res = await aiplatform.notebookRuntimeTemplates.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'persistentResources/my-persistentResource/operations/my-operation', + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * @@ -51908,31 +53359,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Persistentresources$Operations$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Persistentresources$Operations$Delete, + params?: Params$Resource$Notebookruntimetemplates$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Persistentresources$Operations$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Persistentresources$Operations$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Persistentresources$Operations$Delete, + params: Params$Resource$Notebookruntimetemplates$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Persistentresources$Operations$Delete + | Params$Resource$Notebookruntimetemplates$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -51948,12 +53399,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Persistentresources$Operations$Delete; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Persistentresources$Operations$Delete; + params = + {} as Params$Resource$Notebookruntimetemplates$Operations$Delete; options = {}; } @@ -52017,9 +53469,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.persistentResources.operations.get({ + * const res = await aiplatform.notebookRuntimeTemplates.operations.get({ * // The name of the operation resource. - * name: 'persistentResources/my-persistentResource/operations/my-operation', + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * }); * console.log(res.data); * @@ -52046,27 +53498,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Persistentresources$Operations$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Persistentresources$Operations$Get, + params?: Params$Resource$Notebookruntimetemplates$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Persistentresources$Operations$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Persistentresources$Operations$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Persistentresources$Operations$Get, + params: Params$Resource$Notebookruntimetemplates$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -52074,7 +53525,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Persistentresources$Operations$Get + | Params$Resource$Notebookruntimetemplates$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52090,12 +53541,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Persistentresources$Operations$Get; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Persistentresources$Operations$Get; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$Get; options = {}; } @@ -52159,11 +53610,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.persistentResources.operations.list({ + * const res = await aiplatform.notebookRuntimeTemplates.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'persistentResources/my-persistentResource', + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -52194,29 +53645,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Persistentresources$Operations$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Persistentresources$Operations$List, + params?: Params$Resource$Notebookruntimetemplates$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Persistentresources$Operations$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Persistentresources$Operations$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Persistentresources$Operations$List, + params: Params$Resource$Notebookruntimetemplates$Operations$List, callback: BodyResponseCallback ): void; list( @@ -52224,7 +53675,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Persistentresources$Operations$List + | Params$Resource$Notebookruntimetemplates$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52242,12 +53693,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Persistentresources$Operations$List; + {}) as Params$Resource$Notebookruntimetemplates$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Persistentresources$Operations$List; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$List; options = {}; } @@ -52316,9 +53767,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.persistentResources.operations.wait({ + * const res = await aiplatform.notebookRuntimeTemplates.operations.wait({ * // The name of the operation resource to wait on. - * name: 'persistentResources/my-persistentResource/operations/my-operation', + * name: 'notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -52347,27 +53798,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Persistentresources$Operations$Wait, + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Persistentresources$Operations$Wait, + params?: Params$Resource$Notebookruntimetemplates$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Persistentresources$Operations$Wait, + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Persistentresources$Operations$Wait, + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Persistentresources$Operations$Wait, + params: Params$Resource$Notebookruntimetemplates$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -52375,7 +53825,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Persistentresources$Operations$Wait + | Params$Resource$Notebookruntimetemplates$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52391,12 +53841,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Persistentresources$Operations$Wait; + {}) as Params$Resource$Notebookruntimetemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Persistentresources$Operations$Wait; + params = {} as Params$Resource$Notebookruntimetemplates$Operations$Wait; options = {}; } @@ -52431,25 +53881,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Persistentresources$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Notebookruntimetemplates$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Persistentresources$Operations$Delete extends StandardParameters { + export interface Params$Resource$Notebookruntimetemplates$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Persistentresources$Operations$Get extends StandardParameters { + export interface Params$Resource$Notebookruntimetemplates$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Persistentresources$Operations$List extends StandardParameters { + export interface Params$Resource$Notebookruntimetemplates$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -52471,7 +53921,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Persistentresources$Operations$Wait extends StandardParameters { + export interface Params$Resource$Notebookruntimetemplates$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -52482,16 +53932,16 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Pipelinejobs { + export class Resource$Onlineevaluators { context: APIRequestContext; - operations: Resource$Pipelinejobs$Operations; + operations: Resource$Onlineevaluators$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Pipelinejobs$Operations(this.context); + this.operations = new Resource$Onlineevaluators$Operations(this.context); } } - export class Resource$Pipelinejobs$Operations { + export class Resource$Onlineevaluators$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -52527,9 +53977,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.pipelineJobs.operations.cancel({ + * const res = await aiplatform.onlineEvaluators.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'onlineEvaluators/my-onlineEvaluator/operations/my-operation', * }); * console.log(res.data); * @@ -52550,31 +54000,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Onlineevaluators$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Pipelinejobs$Operations$Cancel, + params?: Params$Resource$Onlineevaluators$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Onlineevaluators$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Onlineevaluators$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Onlineevaluators$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Pipelinejobs$Operations$Cancel + | Params$Resource$Onlineevaluators$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52590,12 +54040,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Pipelinejobs$Operations$Cancel; + {}) as Params$Resource$Onlineevaluators$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Pipelinejobs$Operations$Cancel; + params = {} as Params$Resource$Onlineevaluators$Operations$Cancel; options = {}; } @@ -52659,9 +54109,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.pipelineJobs.operations.delete({ + * const res = await aiplatform.onlineEvaluators.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'onlineEvaluators/my-onlineEvaluator/operations/my-operation', * }); * console.log(res.data); * @@ -52682,31 +54132,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Pipelinejobs$Operations$Delete, + params: Params$Resource$Onlineevaluators$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Pipelinejobs$Operations$Delete, + params?: Params$Resource$Onlineevaluators$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Pipelinejobs$Operations$Delete, + params: Params$Resource$Onlineevaluators$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Pipelinejobs$Operations$Delete, + params: Params$Resource$Onlineevaluators$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Pipelinejobs$Operations$Delete, + params: Params$Resource$Onlineevaluators$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Pipelinejobs$Operations$Delete + | Params$Resource$Onlineevaluators$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52722,12 +54172,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Pipelinejobs$Operations$Delete; + {}) as Params$Resource$Onlineevaluators$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Pipelinejobs$Operations$Delete; + params = {} as Params$Resource$Onlineevaluators$Operations$Delete; options = {}; } @@ -52791,9 +54241,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.pipelineJobs.operations.get({ + * const res = await aiplatform.onlineEvaluators.operations.get({ * // The name of the operation resource. - * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'onlineEvaluators/my-onlineEvaluator/operations/my-operation', * }); * console.log(res.data); * @@ -52820,27 +54270,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Pipelinejobs$Operations$Get, + params: Params$Resource$Onlineevaluators$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Pipelinejobs$Operations$Get, + params?: Params$Resource$Onlineevaluators$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Pipelinejobs$Operations$Get, + params: Params$Resource$Onlineevaluators$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Pipelinejobs$Operations$Get, + params: Params$Resource$Onlineevaluators$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Pipelinejobs$Operations$Get, + params: Params$Resource$Onlineevaluators$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -52848,7 +54297,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Pipelinejobs$Operations$Get + | Params$Resource$Onlineevaluators$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -52864,12 +54313,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Pipelinejobs$Operations$Get; + {}) as Params$Resource$Onlineevaluators$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Pipelinejobs$Operations$Get; + params = {} as Params$Resource$Onlineevaluators$Operations$Get; options = {}; } @@ -52933,11 +54382,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.pipelineJobs.operations.list({ + * const res = await aiplatform.onlineEvaluators.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'pipelineJobs/my-pipelineJob', + * name: 'onlineEvaluators/my-onlineEvaluator', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -52968,29 +54417,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Pipelinejobs$Operations$List, + params: Params$Resource$Onlineevaluators$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Pipelinejobs$Operations$List, + params?: Params$Resource$Onlineevaluators$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Pipelinejobs$Operations$List, + params: Params$Resource$Onlineevaluators$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Pipelinejobs$Operations$List, + params: Params$Resource$Onlineevaluators$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Pipelinejobs$Operations$List, + params: Params$Resource$Onlineevaluators$Operations$List, callback: BodyResponseCallback ): void; list( @@ -52998,7 +54447,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Pipelinejobs$Operations$List + | Params$Resource$Onlineevaluators$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53016,12 +54465,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Pipelinejobs$Operations$List; + {}) as Params$Resource$Onlineevaluators$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Pipelinejobs$Operations$List; + params = {} as Params$Resource$Onlineevaluators$Operations$List; options = {}; } @@ -53090,9 +54539,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.pipelineJobs.operations.wait({ + * const res = await aiplatform.onlineEvaluators.operations.wait({ * // The name of the operation resource to wait on. - * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'onlineEvaluators/my-onlineEvaluator/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -53121,27 +54570,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Pipelinejobs$Operations$Wait, + params: Params$Resource$Onlineevaluators$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Pipelinejobs$Operations$Wait, + params?: Params$Resource$Onlineevaluators$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Pipelinejobs$Operations$Wait, + params: Params$Resource$Onlineevaluators$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Pipelinejobs$Operations$Wait, + params: Params$Resource$Onlineevaluators$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Pipelinejobs$Operations$Wait, + params: Params$Resource$Onlineevaluators$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -53149,7 +54597,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Pipelinejobs$Operations$Wait + | Params$Resource$Onlineevaluators$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -53165,12 +54613,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Pipelinejobs$Operations$Wait; + {}) as Params$Resource$Onlineevaluators$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Pipelinejobs$Operations$Wait; + params = {} as Params$Resource$Onlineevaluators$Operations$Wait; options = {}; } @@ -53205,25 +54653,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Pipelinejobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Onlineevaluators$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Pipelinejobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Onlineevaluators$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Pipelinejobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Onlineevaluators$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Pipelinejobs$Operations$List extends StandardParameters { + export interface Params$Resource$Onlineevaluators$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -53245,7 +54693,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Pipelinejobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Onlineevaluators$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -53256,16 +54704,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects { + export class Resource$Operations { context: APIRequestContext; - locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; - this.locations = new Resource$Projects$Locations(this.context); } /** - * Gets a GenAI cache config. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -53294,17 +54740,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.getCacheConfig({ - * // Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - * name: 'projects/my-project/cacheConfig', + * const res = await aiplatform.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "disableCache": false, - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -53319,61 +54762,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, + cancel( + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getCacheConfig( - params?: Params$Resource$Projects$Getcacheconfig, + cancel( + params?: Params$Resource$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, + ): Promise>; + cancel( + params: Params$Resource$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getCacheConfig( - params: Params$Resource$Projects$Getcacheconfig, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getCacheConfig( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Operations$Cancel, + callback: BodyResponseCallback ): void; - getCacheConfig( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Getcacheconfig - | BodyResponseCallback + | Params$Resource$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getcacheconfig; + {}) as Params$Resource$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getcacheconfig; + params = {} as Params$Resource$Operations$Cancel; options = {}; } @@ -53386,8 +54821,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -53398,19 +54833,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a cache config. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -53439,29 +54872,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.updateCacheConfig({ - * // Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - * name: 'projects/my-project/cacheConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "disableCache": false, - * // "name": "my_name" - * // } - * }, + * const res = await aiplatform.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -53476,57 +54894,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, + delete( + params: Params$Resource$Operations$Delete, options: StreamMethodOptions ): Promise>; - updateCacheConfig( - params?: Params$Resource$Projects$Updatecacheconfig, + delete( + params?: Params$Resource$Operations$Delete, options?: MethodOptions - ): Promise>; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, + ): Promise>; + delete( + params: Params$Resource$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateCacheConfig( - params: Params$Resource$Projects$Updatecacheconfig, - callback: BodyResponseCallback + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateCacheConfig( - callback: BodyResponseCallback + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback ): void; - updateCacheConfig( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Updatecacheconfig - | BodyResponseCallback + | Params$Resource$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Updatecacheconfig; + {}) as Params$Resource$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Updatecacheconfig; + params = {} as Params$Resource$Operations$Delete; options = {}; } @@ -53540,7 +54954,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -53551,170 +54965,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Getcacheconfig extends StandardParameters { - /** - * Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - */ - name?: string; - } - export interface Params$Resource$Projects$Updatecacheconfig extends StandardParameters { - /** - * Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CacheConfig; - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; - cachedContents: Resource$Projects$Locations$Cachedcontents; - customJobs: Resource$Projects$Locations$Customjobs; - dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; - datasets: Resource$Projects$Locations$Datasets; - deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; - endpoints: Resource$Projects$Locations$Endpoints; - evaluationItems: Resource$Projects$Locations$Evaluationitems; - evaluationRuns: Resource$Projects$Locations$Evaluationruns; - evaluationSets: Resource$Projects$Locations$Evaluationsets; - featureGroups: Resource$Projects$Locations$Featuregroups; - featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; - featurestores: Resource$Projects$Locations$Featurestores; - hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; - indexEndpoints: Resource$Projects$Locations$Indexendpoints; - indexes: Resource$Projects$Locations$Indexes; - metadataStores: Resource$Projects$Locations$Metadatastores; - migratableResources: Resource$Projects$Locations$Migratableresources; - modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; - models: Resource$Projects$Locations$Models; - nasJobs: Resource$Projects$Locations$Nasjobs; - notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; - notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; - notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; - operations: Resource$Projects$Locations$Operations; - persistentResources: Resource$Projects$Locations$Persistentresources; - pipelineJobs: Resource$Projects$Locations$Pipelinejobs; - publishers: Resource$Projects$Locations$Publishers; - ragCorpora: Resource$Projects$Locations$Ragcorpora; - ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; - reasoningEngines: Resource$Projects$Locations$Reasoningengines; - schedules: Resource$Projects$Locations$Schedules; - skills: Resource$Projects$Locations$Skills; - specialistPools: Resource$Projects$Locations$Specialistpools; - studies: Resource$Projects$Locations$Studies; - tensorboards: Resource$Projects$Locations$Tensorboards; - trainingPipelines: Resource$Projects$Locations$Trainingpipelines; - tuningJobs: Resource$Projects$Locations$Tuningjobs; - constructor(context: APIRequestContext) { - this.context = context; - this.batchPredictionJobs = - new Resource$Projects$Locations$Batchpredictionjobs(this.context); - this.cachedContents = new Resource$Projects$Locations$Cachedcontents( - this.context - ); - this.customJobs = new Resource$Projects$Locations$Customjobs( - this.context - ); - this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( - this.context - ); - this.datasets = new Resource$Projects$Locations$Datasets(this.context); - this.deploymentResourcePools = - new Resource$Projects$Locations$Deploymentresourcepools(this.context); - this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); - this.evaluationItems = new Resource$Projects$Locations$Evaluationitems( - this.context - ); - this.evaluationRuns = new Resource$Projects$Locations$Evaluationruns( - this.context - ); - this.evaluationSets = new Resource$Projects$Locations$Evaluationsets( - this.context - ); - this.featureGroups = new Resource$Projects$Locations$Featuregroups( - this.context - ); - this.featureOnlineStores = - new Resource$Projects$Locations$Featureonlinestores(this.context); - this.featurestores = new Resource$Projects$Locations$Featurestores( - this.context - ); - this.hyperparameterTuningJobs = - new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); - this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( - this.context - ); - this.indexes = new Resource$Projects$Locations$Indexes(this.context); - this.metadataStores = new Resource$Projects$Locations$Metadatastores( - this.context - ); - this.migratableResources = - new Resource$Projects$Locations$Migratableresources(this.context); - this.modelDeploymentMonitoringJobs = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( - this.context - ); - this.models = new Resource$Projects$Locations$Models(this.context); - this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); - this.notebookExecutionJobs = - new Resource$Projects$Locations$Notebookexecutionjobs(this.context); - this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( - this.context - ); - this.notebookRuntimeTemplates = - new Resource$Projects$Locations$Notebookruntimetemplates(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.persistentResources = - new Resource$Projects$Locations$Persistentresources(this.context); - this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( - this.context - ); - this.publishers = new Resource$Projects$Locations$Publishers( - this.context - ); - this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( - this.context - ); - this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( - this.context - ); - this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( - this.context - ); - this.schedules = new Resource$Projects$Locations$Schedules(this.context); - this.skills = new Resource$Projects$Locations$Skills(this.context); - this.specialistPools = new Resource$Projects$Locations$Specialistpools( - this.context - ); - this.studies = new Resource$Projects$Locations$Studies(this.context); - this.tensorboards = new Resource$Projects$Locations$Tensorboards( - this.context - ); - this.trainingPipelines = - new Resource$Projects$Locations$Trainingpipelines(this.context); - this.tuningJobs = new Resource$Projects$Locations$Tuningjobs( - this.context - ); - } /** - * Agentic Retrieval Ask API for RAG. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -53743,25 +55004,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.askContexts({ - * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "query": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.operations.get({ + * // The name of the operation resource. + * name: 'operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "contexts": {}, - * // "response": "my_response" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -53777,61 +55032,55 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - askContexts( - params: Params$Resource$Projects$Locations$Askcontexts, + get( + params: Params$Resource$Operations$Get, options: StreamMethodOptions ): Promise>; - askContexts( - params?: Params$Resource$Projects$Locations$Askcontexts, + get( + params?: Params$Resource$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - askContexts( - params: Params$Resource$Projects$Locations$Askcontexts, + ): Promise>; + get( + params: Params$Resource$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - askContexts( - params: Params$Resource$Projects$Locations$Askcontexts, + get( + params: Params$Resource$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - askContexts( - params: Params$Resource$Projects$Locations$Askcontexts, - callback: BodyResponseCallback + get( + params: Params$Resource$Operations$Get, + callback: BodyResponseCallback ): void; - askContexts( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - askContexts( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Askcontexts - | BodyResponseCallback + | Params$Resource$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Askcontexts; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Askcontexts; + params = {} as Params$Resource$Operations$Get; options = {}; } @@ -53844,34 +55093,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:askContexts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Asynchronous API to retrieves relevant contexts for a query. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -53900,28 +55144,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.asyncRetrieveContexts({ - * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "query": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'placeholder-value', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -53937,57 +55178,60 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - asyncRetrieveContexts( - params: Params$Resource$Projects$Locations$Asyncretrievecontexts, + list( + params: Params$Resource$Operations$List, options: StreamMethodOptions ): Promise>; - asyncRetrieveContexts( - params?: Params$Resource$Projects$Locations$Asyncretrievecontexts, + list( + params?: Params$Resource$Operations$List, options?: MethodOptions - ): Promise>; - asyncRetrieveContexts( - params: Params$Resource$Projects$Locations$Asyncretrievecontexts, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - asyncRetrieveContexts( - params: Params$Resource$Projects$Locations$Asyncretrievecontexts, + list( + params: Params$Resource$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - asyncRetrieveContexts( - params: Params$Resource$Projects$Locations$Asyncretrievecontexts, - callback: BodyResponseCallback + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback ): void; - asyncRetrieveContexts( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - asyncRetrieveContexts( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Asyncretrievecontexts - | BodyResponseCallback + | Params$Resource$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Asyncretrievecontexts; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Asyncretrievecontexts; + params = {} as Params$Resource$Operations$List; options = {}; } @@ -54000,32 +55244,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:asyncRetrieveContexts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/operations').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -54054,26 +55297,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.augmentPrompt({ - * // Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "model": {}, - * // "vertexRagStore": {} - * // } - * }, + * const res = await aiplatform.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "augmentedPrompt": [], - * // "facts": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -54089,61 +55327,55 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + wait( + params: Params$Resource$Operations$Wait, options: StreamMethodOptions ): Promise>; - augmentPrompt( - params?: Params$Resource$Projects$Locations$Augmentprompt, + wait( + params?: Params$Resource$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + ): Promise>; + wait( + params: Params$Resource$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, + wait( + params: Params$Resource$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - augmentPrompt( - params: Params$Resource$Projects$Locations$Augmentprompt, - callback: BodyResponseCallback + wait( + params: Params$Resource$Operations$Wait, + callback: BodyResponseCallback ): void; - augmentPrompt( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - augmentPrompt( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Augmentprompt - | BodyResponseCallback + | Params$Resource$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Augmentprompt; + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Augmentprompt; + params = {} as Params$Resource$Operations$Wait; options = {}; } @@ -54156,34 +55388,98 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:augmentPrompt').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Operations$Cancel extends StandardParameters { /** - * Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Persistentresources { + context: APIRequestContext; + operations: Resource$Persistentresources$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Persistentresources$Operations( + this.context + ); + } + } + + export class Resource$Persistentresources$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -54212,27 +55508,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.corroborateContent({ - * // Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "content": {}, - * // "facts": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.persistentResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "claims": [], - * // "corroborationScore": {} - * // } + * // {} * } * * main().catch(e => { @@ -54247,61 +55530,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; - corroborateContent( - params?: Params$Resource$Projects$Locations$Corroboratecontent, + cancel( + params?: Params$Resource$Persistentresources$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, + ): Promise>; + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - corroborateContent( - params: Params$Resource$Projects$Locations$Corroboratecontent, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - corroborateContent( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Persistentresources$Operations$Cancel, + callback: BodyResponseCallback ): void; - corroborateContent( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Corroboratecontent - | BodyResponseCallback + | Params$Resource$Persistentresources$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Corroboratecontent; + {}) as Params$Resource$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Corroboratecontent; + params = {} as Params$Resource$Persistentresources$Operations$Cancel; options = {}; } @@ -54314,34 +55589,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:corroborateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deploys a model to a new endpoint. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -54370,32 +55640,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploy({ - * // Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` - * destination: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployConfig": {}, - * // "endpointConfig": {}, - * // "huggingFaceModelId": "my_huggingFaceModelId", - * // "modelConfig": {}, - * // "publisherModelName": "my_publisherModelName" - * // } - * }, + * const res = await aiplatform.persistentResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -54410,57 +55662,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deploy( - params: Params$Resource$Projects$Locations$Deploy, + delete( + params: Params$Resource$Persistentresources$Operations$Delete, options: StreamMethodOptions ): Promise>; - deploy( - params?: Params$Resource$Projects$Locations$Deploy, + delete( + params?: Params$Resource$Persistentresources$Operations$Delete, options?: MethodOptions - ): Promise>; - deploy( - params: Params$Resource$Projects$Locations$Deploy, + ): Promise>; + delete( + params: Params$Resource$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deploy( - params: Params$Resource$Projects$Locations$Deploy, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deploy( - params: Params$Resource$Projects$Locations$Deploy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Persistentresources$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deploy( - callback: BodyResponseCallback + delete( + params: Params$Resource$Persistentresources$Operations$Delete, + callback: BodyResponseCallback ): void; - deploy( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploy - | BodyResponseCallback + | Params$Resource$Persistentresources$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploy; + {}) as Params$Resource$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Deploy; + params = {} as Params$Resource$Persistentresources$Operations$Delete; options = {}; } @@ -54473,32 +55721,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+destination}:deploy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['destination'], - pathParams: ['destination'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Evaluates a dataset based on a set of given metrics. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -54527,21 +55772,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluateDataset({ - * // Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoraterConfig": {}, - * // "dataset": {}, - * // "location": "my_location", - * // "metrics": [], - * // "outputConfig": {} - * // } - * }, + * const res = await aiplatform.persistentResources.operations.get({ + * // The name of the operation resource. + * name: 'persistentResources/my-persistentResource/operations/my-operation', * }); * console.log(res.data); * @@ -54567,36 +55800,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + get( + params: Params$Resource$Persistentresources$Operations$Get, options: StreamMethodOptions ): Promise>; - evaluateDataset( - params?: Params$Resource$Projects$Locations$Evaluatedataset, + get( + params?: Params$Resource$Persistentresources$Operations$Get, options?: MethodOptions ): Promise>; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + get( + params: Params$Resource$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + get( + params: Params$Resource$Persistentresources$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateDataset( - params: Params$Resource$Projects$Locations$Evaluatedataset, + get( + params: Params$Resource$Persistentresources$Operations$Get, callback: BodyResponseCallback ): void; - evaluateDataset( + get( callback: BodyResponseCallback ): void; - evaluateDataset( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluatedataset + | Params$Resource$Persistentresources$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -54612,12 +55844,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluatedataset; + {}) as Params$Resource$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluatedataset; + params = {} as Params$Resource$Persistentresources$Operations$Get; options = {}; } @@ -54630,18 +55862,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:evaluateDataset').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -54655,7 +55884,7 @@ export namespace aiplatform_v1 { } /** - * Evaluates instances based on a given metric. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -54684,91 +55913,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluateInstances({ - * // Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "autoraterConfig": {}, - * // "bleuInput": {}, - * // "coherenceInput": {}, - * // "cometInput": {}, - * // "exactMatchInput": {}, - * // "fluencyInput": {}, - * // "fulfillmentInput": {}, - * // "groundednessInput": {}, - * // "instance": {}, - * // "location": "my_location", - * // "metricSources": [], - * // "metrics": [], - * // "metricxInput": {}, - * // "pairwiseMetricInput": {}, - * // "pairwiseQuestionAnsweringQualityInput": {}, - * // "pairwiseSummarizationQualityInput": {}, - * // "pointwiseMetricInput": {}, - * // "questionAnsweringCorrectnessInput": {}, - * // "questionAnsweringHelpfulnessInput": {}, - * // "questionAnsweringQualityInput": {}, - * // "questionAnsweringRelevanceInput": {}, - * // "rougeInput": {}, - * // "rubricBasedInstructionFollowingInput": {}, - * // "safetyInput": {}, - * // "summarizationHelpfulnessInput": {}, - * // "summarizationQualityInput": {}, - * // "summarizationVerbosityInput": {}, - * // "toolCallValidInput": {}, - * // "toolNameMatchInput": {}, - * // "toolParameterKeyMatchInput": {}, - * // "toolParameterKvMatchInput": {}, - * // "trajectoryAnyOrderMatchInput": {}, - * // "trajectoryExactMatchInput": {}, - * // "trajectoryInOrderMatchInput": {}, - * // "trajectoryPrecisionInput": {}, - * // "trajectoryRecallInput": {}, - * // "trajectorySingleToolUseInput": {} - * // } - * }, + * const res = await aiplatform.persistentResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'persistentResources/my-persistentResource', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "bleuResults": {}, - * // "coherenceResult": {}, - * // "cometResult": {}, - * // "exactMatchResults": {}, - * // "fluencyResult": {}, - * // "fulfillmentResult": {}, - * // "groundednessResult": {}, - * // "metricResults": [], - * // "metricxResult": {}, - * // "pairwiseMetricResult": {}, - * // "pairwiseQuestionAnsweringQualityResult": {}, - * // "pairwiseSummarizationQualityResult": {}, - * // "pointwiseMetricResult": {}, - * // "questionAnsweringCorrectnessResult": {}, - * // "questionAnsweringHelpfulnessResult": {}, - * // "questionAnsweringQualityResult": {}, - * // "questionAnsweringRelevanceResult": {}, - * // "rougeResults": {}, - * // "rubricBasedInstructionFollowingResult": {}, - * // "safetyResult": {}, - * // "summarizationHelpfulnessResult": {}, - * // "summarizationQualityResult": {}, - * // "summarizationVerbosityResult": {}, - * // "toolCallValidResults": {}, - * // "toolNameMatchResults": {}, - * // "toolParameterKeyMatchResults": {}, - * // "toolParameterKvMatchResults": {}, - * // "trajectoryAnyOrderMatchResults": {}, - * // "trajectoryExactMatchResults": {}, - * // "trajectoryInOrderMatchResults": {}, - * // "trajectoryPrecisionResults": {}, - * // "trajectoryRecallResults": {}, - * // "trajectorySingleToolUseResults": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -54784,61 +55947,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, + list( + params: Params$Resource$Persistentresources$Operations$List, options: StreamMethodOptions ): Promise>; - evaluateInstances( - params?: Params$Resource$Projects$Locations$Evaluateinstances, + list( + params?: Params$Resource$Persistentresources$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, + list( + params: Params$Resource$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, + list( + params: Params$Resource$Persistentresources$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - evaluateInstances( - params: Params$Resource$Projects$Locations$Evaluateinstances, - callback: BodyResponseCallback + list( + params: Params$Resource$Persistentresources$Operations$List, + callback: BodyResponseCallback ): void; - evaluateInstances( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - evaluateInstances( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluateinstances - | BodyResponseCallback + | Params$Resource$Persistentresources$Operations$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$Evaluateinstances; + {}) as Params$Resource$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluateinstances; + params = {} as Params$Resource$Persistentresources$Operations$List; options = {}; } @@ -54851,34 +56014,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:evaluateInstances').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -54907,28 +56070,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.generateInstanceRubrics({ - * // Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "agentConfig": {}, - * // "contents": [], - * // "location": "my_location", - * // "metricResourceName": "my_metricResourceName", - * // "predefinedRubricGenerationSpec": {}, - * // "rubricGenerationSpec": {} - * // } - * }, + * const res = await aiplatform.persistentResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'persistentResources/my-persistentResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "generatedRubrics": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -54944,62 +56100,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + wait( + params: Params$Resource$Persistentresources$Operations$Wait, options: StreamMethodOptions ): Promise>; - generateInstanceRubrics( - params?: Params$Resource$Projects$Locations$Generateinstancerubrics, + wait( + params?: Params$Resource$Persistentresources$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + ): Promise>; + wait( + params: Params$Resource$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, + wait( + params: Params$Resource$Persistentresources$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateInstanceRubrics( - params: Params$Resource$Projects$Locations$Generateinstancerubrics, - callback: BodyResponseCallback + wait( + params: Params$Resource$Persistentresources$Operations$Wait, + callback: BodyResponseCallback ): void; - generateInstanceRubrics( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - generateInstanceRubrics( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Generateinstancerubrics - | BodyResponseCallback + | Params$Resource$Persistentresources$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generateinstancerubrics; + {}) as Params$Resource$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Generateinstancerubrics; + params = {} as Params$Resource$Persistentresources$Operations$Wait; options = {}; } @@ -55012,34 +56162,96 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:generateInstanceRubrics').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Persistentresources$Operations$Cancel extends StandardParameters { /** - * Generates synthetic (artificial) data based on a description + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Persistentresources$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Persistentresources$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Persistentresources$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Persistentresources$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Pipelinejobs { + context: APIRequestContext; + operations: Resource$Pipelinejobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Pipelinejobs$Operations(this.context); + } + } + + export class Resource$Pipelinejobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -55068,27 +56280,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.generateSyntheticData({ - * // Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project\}/locations/{location\}`. For example, `projects/my-project/locations/us-central1`. - * location: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "count": 0, - * // "examples": [], - * // "outputFieldSpecs": [], - * // "taskDescription": {} - * // } - * }, + * const res = await aiplatform.pipelineJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "syntheticExamples": [] - * // } + * // {} * } * * main().catch(e => { @@ -55103,61 +56302,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - generateSyntheticData( - params?: Params$Resource$Projects$Locations$Generatesyntheticdata, + cancel( + params?: Params$Resource$Pipelinejobs$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, + ): Promise>; + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateSyntheticData( - params: Params$Resource$Projects$Locations$Generatesyntheticdata, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateSyntheticData( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Pipelinejobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - generateSyntheticData( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Generatesyntheticdata - | BodyResponseCallback + | Params$Resource$Pipelinejobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Generatesyntheticdata; + {}) as Params$Resource$Pipelinejobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Generatesyntheticdata; + params = {} as Params$Resource$Pipelinejobs$Operations$Cancel; options = {}; } @@ -55170,34 +56361,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+location}:generateSyntheticData').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets information about a location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -55226,20 +56412,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.get({ - * // Resource name for the location. - * name: 'projects/my-project/locations/my-location', + * const res = await aiplatform.pipelineJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "displayName": "my_displayName", - * // "labels": {}, - * // "locationId": "my_locationId", - * // "metadata": {}, - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -55254,57 +56434,53 @@ export namespace aiplatform_v1 { * @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$Get, + delete( + params: Params$Resource$Pipelinejobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Get, + delete( + params?: Params$Resource$Pipelinejobs$Operations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Get, + ): Promise>; + delete( + params: Params$Resource$Pipelinejobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Pipelinejobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Pipelinejobs$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Pipelinejobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Pipelinejobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = {} as Params$Resource$Pipelinejobs$Operations$Delete; options = {}; } @@ -55318,7 +56494,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -55329,17 +56505,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a RagEngineConfig. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -55368,16 +56544,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.getRagEngineConfig({ - * // Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` - * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * const res = await aiplatform.pipelineJobs.operations.get({ + * // The name of the operation resource. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "ragManagedDbConfig": {} + * // "response": {} * // } * } * @@ -55393,61 +56572,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params: Params$Resource$Pipelinejobs$Operations$Get, options: StreamMethodOptions ): Promise>; - getRagEngineConfig( - params?: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params?: Params$Resource$Pipelinejobs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + ): Promise>; + get( + params: Params$Resource$Pipelinejobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, + get( + params: Params$Resource$Pipelinejobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getRagEngineConfig( - params: Params$Resource$Projects$Locations$Getragengineconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Pipelinejobs$Operations$Get, + callback: BodyResponseCallback ): void; - getRagEngineConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getRagEngineConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Getragengineconfig - | BodyResponseCallback + | Params$Resource$Pipelinejobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Getragengineconfig; + {}) as Params$Resource$Pipelinejobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Getragengineconfig; + params = {} as Params$Resource$Pipelinejobs$Operations$Get; options = {}; } @@ -55472,19 +56646,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -55513,24 +56685,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.list({ - * // Optional. Do not use this field 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). + * const res = await aiplatform.pipelineJobs.operations.list({ + * // The standard list filter. * filter: 'placeholder-value', - * // The resource that owns the locations collection, if applicable. - * name: 'projects/my-project', - * // The maximum number of results to return. If not set, the service selects a default. + * // The name of the operation's parent resource. + * name: 'pipelineJobs/my-pipelineJob', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "locations": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -55547,60 +56720,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Pipelinejobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Pipelinejobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Pipelinejobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Pipelinejobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Pipelinejobs$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Pipelinejobs$Operations$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$List; + {}) as Params$Resource$Pipelinejobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = {} as Params$Resource$Pipelinejobs$Operations$List; options = {}; } @@ -55613,7 +56786,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -55628,175 +56801,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Retrieves relevant contexts for a query. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.retrieveContexts({ - * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "query": {}, - * // "vertexRagStore": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "contexts": {} - * // } - * } - * - * 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. - */ - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, - options: StreamMethodOptions - ): Promise>; - retrieveContexts( - params?: Params$Resource$Projects$Locations$Retrievecontexts, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - retrieveContexts( - params: Params$Resource$Projects$Locations$Retrievecontexts, - callback: BodyResponseCallback - ): void; - retrieveContexts( - callback: BodyResponseCallback - ): void; - retrieveContexts( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Retrievecontexts - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Retrievecontexts; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Retrievecontexts; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}:retrieveContexts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a RagEngineConfig. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -55825,18 +56842,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.updateRagEngineConfig({ - * // Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` - * name: 'projects/my-project/locations/my-location/ragEngineConfig', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "name": "my_name", - * // "ragManagedDbConfig": {} - * // } - * }, + * const res = await aiplatform.pipelineJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'pipelineJobs/my-pipelineJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -55862,36 +56872,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + wait( + params: Params$Resource$Pipelinejobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - updateRagEngineConfig( - params?: Params$Resource$Projects$Locations$Updateragengineconfig, + wait( + params?: Params$Resource$Pipelinejobs$Operations$Wait, options?: MethodOptions ): Promise>; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + wait( + params: Params$Resource$Pipelinejobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + wait( + params: Params$Resource$Pipelinejobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateRagEngineConfig( - params: Params$Resource$Projects$Locations$Updateragengineconfig, + wait( + params: Params$Resource$Pipelinejobs$Operations$Wait, callback: BodyResponseCallback ): void; - updateRagEngineConfig( + wait( callback: BodyResponseCallback ): void; - updateRagEngineConfig( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updateragengineconfig + | Params$Resource$Pipelinejobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55907,12 +56916,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updateragengineconfig; + {}) as Params$Resource$Pipelinejobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updateragengineconfig; + params = {} as Params$Resource$Pipelinejobs$Operations$Wait; options = {}; } @@ -55925,8 +56934,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -55947,170 +56956,67 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Askcontexts extends StandardParameters { - /** - * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AskContextsRequest; - } - export interface Params$Resource$Projects$Locations$Asyncretrievecontexts extends StandardParameters { - /** - * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AsyncRetrieveContextsRequest; - } - export interface Params$Resource$Projects$Locations$Augmentprompt extends StandardParameters { - /** - * Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AugmentPromptRequest; - } - export interface Params$Resource$Projects$Locations$Corroboratecontent extends StandardParameters { - /** - * Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CorroborateContentRequest; - } - export interface Params$Resource$Projects$Locations$Deploy extends StandardParameters { - /** - * Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` - */ - destination?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployRequest; - } - export interface Params$Resource$Projects$Locations$Evaluatedataset extends StandardParameters { - /** - * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Evaluateinstances extends StandardParameters { - /** - * Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest; - } - export interface Params$Resource$Projects$Locations$Generateinstancerubrics extends StandardParameters { - /** - * Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest; - } - export interface Params$Resource$Projects$Locations$Generatesyntheticdata extends StandardParameters { - /** - * Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project\}/locations/{location\}`. For example, `projects/my-project/locations/us-central1`. - */ - location?: string; - + export interface Params$Resource$Pipelinejobs$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Get extends StandardParameters { + export interface Params$Resource$Pipelinejobs$Operations$Delete extends StandardParameters { /** - * Resource name for the location. + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Getragengineconfig extends StandardParameters { + export interface Params$Resource$Pipelinejobs$Operations$Get extends StandardParameters { /** - * Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$List extends StandardParameters { - /** - * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. - */ - extraLocationTypes?: string[]; + export interface Params$Resource$Pipelinejobs$Operations$List extends StandardParameters { /** - * 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). + * The standard list filter. */ filter?: string; /** - * The resource that owns the locations collection, if applicable. + * The name of the operation's parent resource. */ name?: string; /** - * The maximum number of results to return. If not set, the service selects a default. + * The standard list page size. */ pageSize?: number; /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * The standard list page token. */ pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Retrievecontexts extends StandardParameters { - /** - * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Request body metadata + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1RetrieveContextsRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Updateragengineconfig extends StandardParameters { + export interface Params$Resource$Pipelinejobs$Operations$Wait extends StandardParameters { /** - * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1RagEngineConfig; + timeout?: string; } - export class Resource$Projects$Locations$Batchpredictionjobs { + export class Resource$Projects { context: APIRequestContext; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Projects$Locations(this.context); } /** - * Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. + * Gets a GenAI cache config. * @example * ```js * // Before running the sample: @@ -56139,20 +57045,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.cancel({ - * // Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.getCacheConfig({ + * // Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + * name: 'projects/my-project/cacheConfig', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "disableCache": false, + * // "name": "my_name" + * // } * } * * main().catch(e => { @@ -56167,54 +57070,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + getCacheConfig( + params?: Params$Resource$Projects$Getcacheconfig, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, - callback: BodyResponseCallback + getCacheConfig( + params: Params$Resource$Projects$Getcacheconfig, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + getCacheConfig( + callback: BodyResponseCallback + ): void; + getCacheConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Getcacheconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + {}) as Params$Resource$Projects$Getcacheconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; + params = {} as Params$Resource$Projects$Getcacheconfig; options = {}; } @@ -56227,8 +57137,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -56239,17 +57149,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. + * Updates a cache config. * @example * ```js * // Before running the sample: @@ -56278,43 +57190,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.create({ - * // Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.updateCacheConfig({ + * // Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + * name: 'projects/my-project/cacheConfig', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", - * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" + * // "disableCache": false, + * // "name": "my_name" * // } * }, * }); @@ -56322,35 +57207,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", + * // "done": false, * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", + * // "metadata": {}, * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -56366,62 +57227,56 @@ export namespace aiplatform_v1 { * @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$Batchpredictionjobs$Create, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + updateCacheConfig( + params?: Params$Resource$Projects$Updatecacheconfig, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + ): Promise>; + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, - callback: BodyResponseCallback + updateCacheConfig( + params: Params$Resource$Projects$Updatecacheconfig, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + updateCacheConfig( + callback: BodyResponseCallback ): void; - create( + updateCacheConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Updatecacheconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + {}) as Params$Resource$Projects$Updatecacheconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; + params = {} as Params$Resource$Projects$Updatecacheconfig; options = {}; } @@ -56434,46 +57289,221 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Getcacheconfig extends StandardParameters { /** - * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis + * Required. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + */ + name?: string; + } + export interface Params$Resource$Projects$Updatecacheconfig extends StandardParameters { + /** + * Identifier. Name of the cache config. Format: - `projects/{project\}/cacheConfig`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CacheConfig; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + agents: Resource$Projects$Locations$Agents; + batchPredictionJobs: Resource$Projects$Locations$Batchpredictionjobs; + cachedContents: Resource$Projects$Locations$Cachedcontents; + customJobs: Resource$Projects$Locations$Customjobs; + dataLabelingJobs: Resource$Projects$Locations$Datalabelingjobs; + datasets: Resource$Projects$Locations$Datasets; + deploymentResourcePools: Resource$Projects$Locations$Deploymentresourcepools; + endpoints: Resource$Projects$Locations$Endpoints; + evaluationItems: Resource$Projects$Locations$Evaluationitems; + evaluationMetrics: Resource$Projects$Locations$Evaluationmetrics; + evaluationRuns: Resource$Projects$Locations$Evaluationruns; + evaluationSets: Resource$Projects$Locations$Evaluationsets; + featureGroups: Resource$Projects$Locations$Featuregroups; + featureOnlineStores: Resource$Projects$Locations$Featureonlinestores; + featurestores: Resource$Projects$Locations$Featurestores; + hyperparameterTuningJobs: Resource$Projects$Locations$Hyperparametertuningjobs; + indexEndpoints: Resource$Projects$Locations$Indexendpoints; + indexes: Resource$Projects$Locations$Indexes; + memoryBanks: Resource$Projects$Locations$Memorybanks; + metadataStores: Resource$Projects$Locations$Metadatastores; + migratableResources: Resource$Projects$Locations$Migratableresources; + modelDeploymentMonitoringJobs: Resource$Projects$Locations$Modeldeploymentmonitoringjobs; + models: Resource$Projects$Locations$Models; + nasJobs: Resource$Projects$Locations$Nasjobs; + notebookExecutionJobs: Resource$Projects$Locations$Notebookexecutionjobs; + notebookRuntimes: Resource$Projects$Locations$Notebookruntimes; + notebookRuntimeTemplates: Resource$Projects$Locations$Notebookruntimetemplates; + onlineEvaluators: Resource$Projects$Locations$Onlineevaluators; + operations: Resource$Projects$Locations$Operations; + persistentResources: Resource$Projects$Locations$Persistentresources; + pipelineJobs: Resource$Projects$Locations$Pipelinejobs; + publishers: Resource$Projects$Locations$Publishers; + ragCorpora: Resource$Projects$Locations$Ragcorpora; + ragEngineConfig: Resource$Projects$Locations$Ragengineconfig; + reasoningEngines: Resource$Projects$Locations$Reasoningengines; + schedules: Resource$Projects$Locations$Schedules; + semanticGovernancePolicies: Resource$Projects$Locations$Semanticgovernancepolicies; + semanticGovernancePolicyEngine: Resource$Projects$Locations$Semanticgovernancepolicyengine; + servingProfiles: Resource$Projects$Locations$Servingprofiles; + skills: Resource$Projects$Locations$Skills; + specialistPools: Resource$Projects$Locations$Specialistpools; + studies: Resource$Projects$Locations$Studies; + tensorboards: Resource$Projects$Locations$Tensorboards; + trainingPipelines: Resource$Projects$Locations$Trainingpipelines; + tuningJobs: Resource$Projects$Locations$Tuningjobs; + constructor(context: APIRequestContext) { + this.context = context; + this.agents = new Resource$Projects$Locations$Agents(this.context); + this.batchPredictionJobs = + new Resource$Projects$Locations$Batchpredictionjobs(this.context); + this.cachedContents = new Resource$Projects$Locations$Cachedcontents( + this.context + ); + this.customJobs = new Resource$Projects$Locations$Customjobs( + this.context + ); + this.dataLabelingJobs = new Resource$Projects$Locations$Datalabelingjobs( + this.context + ); + this.datasets = new Resource$Projects$Locations$Datasets(this.context); + this.deploymentResourcePools = + new Resource$Projects$Locations$Deploymentresourcepools(this.context); + this.endpoints = new Resource$Projects$Locations$Endpoints(this.context); + this.evaluationItems = new Resource$Projects$Locations$Evaluationitems( + this.context + ); + this.evaluationMetrics = + new Resource$Projects$Locations$Evaluationmetrics(this.context); + this.evaluationRuns = new Resource$Projects$Locations$Evaluationruns( + this.context + ); + this.evaluationSets = new Resource$Projects$Locations$Evaluationsets( + this.context + ); + this.featureGroups = new Resource$Projects$Locations$Featuregroups( + this.context + ); + this.featureOnlineStores = + new Resource$Projects$Locations$Featureonlinestores(this.context); + this.featurestores = new Resource$Projects$Locations$Featurestores( + this.context + ); + this.hyperparameterTuningJobs = + new Resource$Projects$Locations$Hyperparametertuningjobs(this.context); + this.indexEndpoints = new Resource$Projects$Locations$Indexendpoints( + this.context + ); + this.indexes = new Resource$Projects$Locations$Indexes(this.context); + this.memoryBanks = new Resource$Projects$Locations$Memorybanks( + this.context + ); + this.metadataStores = new Resource$Projects$Locations$Metadatastores( + this.context + ); + this.migratableResources = + new Resource$Projects$Locations$Migratableresources(this.context); + this.modelDeploymentMonitoringJobs = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs( + this.context + ); + this.models = new Resource$Projects$Locations$Models(this.context); + this.nasJobs = new Resource$Projects$Locations$Nasjobs(this.context); + this.notebookExecutionJobs = + new Resource$Projects$Locations$Notebookexecutionjobs(this.context); + this.notebookRuntimes = new Resource$Projects$Locations$Notebookruntimes( + this.context + ); + this.notebookRuntimeTemplates = + new Resource$Projects$Locations$Notebookruntimetemplates(this.context); + this.onlineEvaluators = new Resource$Projects$Locations$Onlineevaluators( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.persistentResources = + new Resource$Projects$Locations$Persistentresources(this.context); + this.pipelineJobs = new Resource$Projects$Locations$Pipelinejobs( + this.context + ); + this.publishers = new Resource$Projects$Locations$Publishers( + this.context + ); + this.ragCorpora = new Resource$Projects$Locations$Ragcorpora( + this.context + ); + this.ragEngineConfig = new Resource$Projects$Locations$Ragengineconfig( + this.context + ); + this.reasoningEngines = new Resource$Projects$Locations$Reasoningengines( + this.context + ); + this.schedules = new Resource$Projects$Locations$Schedules(this.context); + this.semanticGovernancePolicies = + new Resource$Projects$Locations$Semanticgovernancepolicies( + this.context + ); + this.semanticGovernancePolicyEngine = + new Resource$Projects$Locations$Semanticgovernancepolicyengine( + this.context + ); + this.servingProfiles = new Resource$Projects$Locations$Servingprofiles( + this.context + ); + this.skills = new Resource$Projects$Locations$Skills(this.context); + this.specialistPools = new Resource$Projects$Locations$Specialistpools( + this.context + ); + this.studies = new Resource$Projects$Locations$Studies(this.context); + this.tensorboards = new Resource$Projects$Locations$Tensorboards( + this.context + ); + this.trainingPipelines = + new Resource$Projects$Locations$Trainingpipelines(this.context); + this.tuningJobs = new Resource$Projects$Locations$Tuningjobs( + this.context + ); + } + + /** + * Agentic Retrieval Ask API for RAG. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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'); @@ -56490,19 +57520,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.delete({ - * // Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * const res = await aiplatform.projects.locations.askContexts({ + * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "tools": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contexts": {}, + * // "response": "my_response" * // } * } * @@ -56518,58 +57554,61 @@ export namespace aiplatform_v1 { * @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$Batchpredictionjobs$Delete, + askContexts( + params: Params$Resource$Projects$Locations$Askcontexts, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + askContexts( + params?: Params$Resource$Projects$Locations$Askcontexts, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + askContexts( + params: Params$Resource$Projects$Locations$Askcontexts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, + askContexts( + params: Params$Resource$Projects$Locations$Askcontexts, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, - callback: BodyResponseCallback + askContexts( + params: Params$Resource$Projects$Locations$Askcontexts, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + askContexts( + callback: BodyResponseCallback ): void; - delete( + askContexts( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Askcontexts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + {}) as Params$Resource$Projects$Locations$Askcontexts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Askcontexts; options = {}; } @@ -56582,29 +57621,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}:askContexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a BatchPredictionJob + * Asynchronous API to retrieves relevant contexts for a query. * @example * ```js * // Before running the sample: @@ -56633,43 +57677,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.get({ - * // Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * const res = await aiplatform.projects.locations.asyncRetrieveContexts({ + * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "tools": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "completionStats": {}, - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", + * // "done": false, * // "error": {}, - * // "explanationSpec": {}, - * // "generateExplanation": false, - * // "inputConfig": {}, - * // "instanceConfig": {}, - * // "labels": {}, - * // "manualBatchTuningParameters": {}, - * // "model": "my_model", - * // "modelParameters": {}, - * // "modelVersionId": "my_modelVersionId", + * // "metadata": {}, * // "name": "my_name", - * // "outputConfig": {}, - * // "outputInfo": {}, - * // "partialFailures": [], - * // "resourcesConsumed": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "unmanagedContainerModel": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -56685,62 +57714,56 @@ export namespace aiplatform_v1 { * @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$Batchpredictionjobs$Get, + asyncRetrieveContexts( + params: Params$Resource$Projects$Locations$Asyncretrievecontexts, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + asyncRetrieveContexts( + params?: Params$Resource$Projects$Locations$Asyncretrievecontexts, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + ): Promise>; + asyncRetrieveContexts( + params: Params$Resource$Projects$Locations$Asyncretrievecontexts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + asyncRetrieveContexts( + params: Params$Resource$Projects$Locations$Asyncretrievecontexts, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, - callback: BodyResponseCallback + asyncRetrieveContexts( + params: Params$Resource$Projects$Locations$Asyncretrievecontexts, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + asyncRetrieveContexts( + callback: BodyResponseCallback ): void; - get( + asyncRetrieveContexts( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Asyncretrievecontexts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + {}) as Params$Resource$Projects$Locations$Asyncretrievecontexts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; + params = {} as Params$Resource$Projects$Locations$Asyncretrievecontexts; options = {}; } @@ -56753,31 +57776,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}:asyncRetrieveContexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists BatchPredictionJobs in a Location. + * Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses. * @example * ```js * // Before running the sample: @@ -56806,24 +57830,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.batchPredictionJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.augmentPrompt({ + * // Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "model": {}, + * // "vertexRagStore": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "batchPredictionJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "augmentedPrompt": [], + * // "facts": [] * // } * } * @@ -56839,62 +57865,61 @@ export namespace aiplatform_v1 { * @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$Batchpredictionjobs$List, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + augmentPrompt( + params?: Params$Resource$Projects$Locations$Augmentprompt, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, - callback: BodyResponseCallback + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + augmentPrompt( + callback: BodyResponseCallback ): void; - list( + augmentPrompt( paramsOrCallback?: - | Params$Resource$Projects$Locations$Batchpredictionjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Augmentprompt + | 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$Batchpredictionjobs$List; + {}) as Params$Resource$Projects$Locations$Augmentprompt; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; + params = {} as Params$Resource$Projects$Locations$Augmentprompt; options = {}; } @@ -56907,11 +57932,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( + url: (rootUrl + '/v1/{+parent}:augmentPrompt').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -56922,83 +57947,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel extends StandardParameters { - /** - * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete extends StandardParameters { - /** - * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get extends StandardParameters { - /** - * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Cachedcontents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. + * Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. * @example * ```js * // Before running the sample: @@ -57027,27 +57988,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.create({ - * // Required. The parent resource where the cached content will be created + * const res = await aiplatform.projects.locations.corroborateContent({ + * // Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "content": {}, + * // "facts": [], + * // "parameters": {} * // } * }, * }); @@ -57055,19 +58006,8 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "claims": [], + * // "corroborationScore": {} * // } * } * @@ -57083,61 +58023,61 @@ export namespace aiplatform_v1 { * @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$Cachedcontents$Create, + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Cachedcontents$Create, + corroborateContent( + params?: Params$Resource$Projects$Locations$Corroboratecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Cachedcontents$Create, - callback: BodyResponseCallback + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + corroborateContent( + callback: BodyResponseCallback ): void; - create( + corroborateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Corroboratecontent + | 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$Cachedcontents$Create; + {}) as Params$Resource$Projects$Locations$Corroboratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Create; + params = {} as Params$Resource$Projects$Locations$Corroboratecontent; options = {}; } @@ -57150,7 +58090,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cachedContents').replace( + url: (rootUrl + '/v1/{+parent}:corroborateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -57165,19 +58105,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes cached content + * Deploys a model to a new endpoint. * @example * ```js * // Before running the sample: @@ -57206,14 +58146,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.delete({ - * // Required. The resource name referring to the cached content - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * const res = await aiplatform.projects.locations.deploy({ + * // Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` + * destination: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployConfig": {}, + * // "endpointConfig": {}, + * // "huggingFaceModelId": "my_huggingFaceModelId", + * // "modelConfig": {}, + * // "publisherModelName": "my_publisherModelName" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -57228,53 +58186,56 @@ export namespace aiplatform_v1 { * @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$Cachedcontents$Delete, + deploy( + params: Params$Resource$Projects$Locations$Deploy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Cachedcontents$Delete, + deploy( + params?: Params$Resource$Projects$Locations$Deploy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + ): Promise>; + deploy( + params: Params$Resource$Projects$Locations$Deploy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + deploy( + params: Params$Resource$Projects$Locations$Deploy, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Cachedcontents$Delete, - callback: BodyResponseCallback + deploy( + params: Params$Resource$Projects$Locations$Deploy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + deploy( + callback: BodyResponseCallback + ): void; + deploy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Delete; + {}) as Params$Resource$Projects$Locations$Deploy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Delete; + params = {} as Params$Resource$Projects$Locations$Deploy; options = {}; } @@ -57287,29 +58248,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+destination}:deploy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['destination'], + pathParams: ['destination'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets cached content configurations + * Evaluates a dataset based on a set of given metrics. * @example * ```js * // Before running the sample: @@ -57338,27 +58302,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.get({ - * // Required. The resource name referring to the cached content - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * const res = await aiplatform.projects.locations.evaluateDataset({ + * // Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoraterConfig": {}, + * // "dataset": {}, + * // "location": "my_location", + * // "metrics": [], + * // "outputConfig": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "response": {} * // } * } * @@ -57374,61 +58342,56 @@ export namespace aiplatform_v1 { * @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$Cachedcontents$Get, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Cachedcontents$Get, + evaluateDataset( + params?: Params$Resource$Projects$Locations$Evaluatedataset, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, + ): Promise>; + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Cachedcontents$Get, - callback: BodyResponseCallback + evaluateDataset( + params: Params$Resource$Projects$Locations$Evaluatedataset, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + evaluateDataset( + callback: BodyResponseCallback ): void; - get( + evaluateDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluatedataset + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cachedcontents$Get; + {}) as Params$Resource$Projects$Locations$Evaluatedataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Get; + params = {} as Params$Resource$Projects$Locations$Evaluatedataset; options = {}; } @@ -57441,31 +58404,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+location}:evaluateDataset').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists cached contents in a project + * Evaluates instances based on a given metric. * @example * ```js * // Before running the sample: @@ -57494,20 +58458,91 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.list({ - * // Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent, which owns this collection of cached contents. - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.evaluateInstances({ + * // Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "autoraterConfig": {}, + * // "bleuInput": {}, + * // "coherenceInput": {}, + * // "cometInput": {}, + * // "exactMatchInput": {}, + * // "fluencyInput": {}, + * // "fulfillmentInput": {}, + * // "groundednessInput": {}, + * // "instance": {}, + * // "location": "my_location", + * // "metricSources": [], + * // "metrics": [], + * // "metricxInput": {}, + * // "pairwiseMetricInput": {}, + * // "pairwiseQuestionAnsweringQualityInput": {}, + * // "pairwiseSummarizationQualityInput": {}, + * // "pointwiseMetricInput": {}, + * // "questionAnsweringCorrectnessInput": {}, + * // "questionAnsweringHelpfulnessInput": {}, + * // "questionAnsweringQualityInput": {}, + * // "questionAnsweringRelevanceInput": {}, + * // "rougeInput": {}, + * // "rubricBasedInstructionFollowingInput": {}, + * // "safetyInput": {}, + * // "summarizationHelpfulnessInput": {}, + * // "summarizationQualityInput": {}, + * // "summarizationVerbosityInput": {}, + * // "toolCallValidInput": {}, + * // "toolNameMatchInput": {}, + * // "toolParameterKeyMatchInput": {}, + * // "toolParameterKvMatchInput": {}, + * // "trajectoryAnyOrderMatchInput": {}, + * // "trajectoryExactMatchInput": {}, + * // "trajectoryInOrderMatchInput": {}, + * // "trajectoryPrecisionInput": {}, + * // "trajectoryRecallInput": {}, + * // "trajectorySingleToolUseInput": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "cachedContents": [], - * // "nextPageToken": "my_nextPageToken" + * // "bleuResults": {}, + * // "coherenceResult": {}, + * // "cometResult": {}, + * // "exactMatchResults": {}, + * // "fluencyResult": {}, + * // "fulfillmentResult": {}, + * // "groundednessResult": {}, + * // "metricResults": [], + * // "metricxResult": {}, + * // "pairwiseMetricResult": {}, + * // "pairwiseQuestionAnsweringQualityResult": {}, + * // "pairwiseSummarizationQualityResult": {}, + * // "pointwiseMetricResult": {}, + * // "questionAnsweringCorrectnessResult": {}, + * // "questionAnsweringHelpfulnessResult": {}, + * // "questionAnsweringQualityResult": {}, + * // "questionAnsweringRelevanceResult": {}, + * // "rougeResults": {}, + * // "rubricBasedInstructionFollowingResult": {}, + * // "safetyResult": {}, + * // "summarizationHelpfulnessResult": {}, + * // "summarizationQualityResult": {}, + * // "summarizationVerbosityResult": {}, + * // "toolCallValidResults": {}, + * // "toolNameMatchResults": {}, + * // "toolParameterKeyMatchResults": {}, + * // "toolParameterKvMatchResults": {}, + * // "trajectoryAnyOrderMatchResults": {}, + * // "trajectoryExactMatchResults": {}, + * // "trajectoryInOrderMatchResults": {}, + * // "trajectoryPrecisionResults": {}, + * // "trajectoryRecallResults": {}, + * // "trajectorySingleToolUseResults": {} * // } * } * @@ -57523,61 +58558,61 @@ export namespace aiplatform_v1 { * @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$Cachedcontents$List, + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Cachedcontents$List, + evaluateInstances( + params?: Params$Resource$Projects$Locations$Evaluateinstances, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Cachedcontents$List, - callback: BodyResponseCallback + evaluateInstances( + params: Params$Resource$Projects$Locations$Evaluateinstances, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + evaluateInstances( + callback: BodyResponseCallback ): void; - list( + evaluateInstances( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluateinstances + | 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$Cachedcontents$List; + {}) as Params$Resource$Projects$Locations$Evaluateinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$List; + params = {} as Params$Resource$Projects$Locations$Evaluateinstances; options = {}; } @@ -57590,34 +58625,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/cachedContents').replace( + url: (rootUrl + '/v1/{+location}:evaluateInstances').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates cached content configurations + * Generates rubrics for a given prompt. A rubric represents a single testable criterion for evaluation. One input prompt could have multiple rubrics This RPC allows users to get suggested rubrics based on provided prompt, which can then be reviewed and used for subsequent evaluations. * @example * ```js * // Before running the sample: @@ -57646,29 +58681,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.cachedContents.patch({ - * // Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} - * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', - * // Required. The list of fields to update. - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.generateInstanceRubrics({ + * // Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "agentConfig": {}, * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "location": "my_location", + * // "metricResourceName": "my_metricResourceName", + * // "predefinedRubricGenerationSpec": {}, + * // "rubricGenerationSpec": {} * // } * }, * }); @@ -57676,19 +58702,7 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "contents": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "expireTime": "my_expireTime", - * // "model": "my_model", - * // "name": "my_name", - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "usageMetadata": {} + * // "generatedRubrics": [] * // } * } * @@ -57704,61 +58718,62 @@ export namespace aiplatform_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$Cachedcontents$Patch, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Cachedcontents$Patch, + generateInstanceRubrics( + params?: Params$Resource$Projects$Locations$Generateinstancerubrics, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Cachedcontents$Patch, - callback: BodyResponseCallback + generateInstanceRubrics( + params: Params$Resource$Projects$Locations$Generateinstancerubrics, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + generateInstanceRubrics( + callback: BodyResponseCallback ): void; - patch( + generateInstanceRubrics( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cachedcontents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generateinstancerubrics + | 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$Cachedcontents$Patch; + {}) as Params$Resource$Projects$Locations$Generateinstancerubrics; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cachedcontents$Patch; + params = + {} as Params$Resource$Projects$Locations$Generateinstancerubrics; options = {}; } @@ -57771,95 +58786,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+location}:generateInstanceRubrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Cachedcontents$Create extends StandardParameters { - /** - * Required. The parent resource where the cached content will be created - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; - } - export interface Params$Resource$Projects$Locations$Cachedcontents$Delete extends StandardParameters { - /** - * Required. The resource name referring to the cached content - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Cachedcontents$Get extends StandardParameters { - /** - * Required. The resource name referring to the cached content - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Cachedcontents$List extends StandardParameters { - /** - * Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of cached contents. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Cachedcontents$Patch extends StandardParameters { - /** - * Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} - */ - name?: string; - /** - * Required. The list of fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; - } - - export class Resource$Projects$Locations$Customjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Customjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Customjobs$Operations( - this.context - ); - } /** - * Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. + * Generates loss clusters from evaluation results. This is a statelss API method that would not modify the EvaluationSet resource. * @example * ```js * // Before running the sample: @@ -57888,20 +58842,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.cancel({ - * // Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * const res = await aiplatform.projects.locations.generateLossClusters({ + * // Required. The resource name of the Location. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "configs": [], + * // "evaluationSet": "my_evaluationSet", + * // "inlineResults": {} + * // } * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -57916,53 +58880,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + generateLossClusters( + params: Params$Resource$Projects$Locations$Generatelossclusters, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Cancel, + generateLossClusters( + params?: Params$Resource$Projects$Locations$Generatelossclusters, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, + ): Promise>; + generateLossClusters( + params: Params$Resource$Projects$Locations$Generatelossclusters, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + generateLossClusters( + params: Params$Resource$Projects$Locations$Generatelossclusters, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Cancel, - callback: BodyResponseCallback + generateLossClusters( + params: Params$Resource$Projects$Locations$Generatelossclusters, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + generateLossClusters( + callback: BodyResponseCallback + ): void; + generateLossClusters( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generatelossclusters + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Generatelossclusters; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; + params = {} as Params$Resource$Projects$Locations$Generatelossclusters; options = {}; } @@ -57975,29 +58942,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+location}:generateLossClusters').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a CustomJob. A created CustomJob right away will be attempted to be run. + * Generates synthetic (artificial) data based on a description * @example * ```js * // Before running the sample: @@ -58026,28 +58996,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.create({ - * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.generateSyntheticData({ + * // Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project\}/locations/{location\}`. For example, `projects/my-project/locations/us-central1`. + * location: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, - * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} + * // "count": 0, + * // "examples": [], + * // "outputFieldSpecs": [], + * // "taskDescription": {} * // } * }, * }); @@ -58055,20 +59015,7 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, - * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} + * // "syntheticExamples": [] * // } * } * @@ -58084,61 +59031,61 @@ export namespace aiplatform_v1 { * @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$Customjobs$Create, + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Customjobs$Create, + generateSyntheticData( + params?: Params$Resource$Projects$Locations$Generatesyntheticdata, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Customjobs$Create, - callback: BodyResponseCallback + generateSyntheticData( + params: Params$Resource$Projects$Locations$Generatesyntheticdata, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + generateSyntheticData( + callback: BodyResponseCallback ): void; - create( + generateSyntheticData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generatesyntheticdata + | 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$Customjobs$Create; + {}) as Params$Resource$Projects$Locations$Generatesyntheticdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Create; + params = {} as Params$Resource$Projects$Locations$Generatesyntheticdata; options = {}; } @@ -58151,7 +59098,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( + url: (rootUrl + '/v1/{+location}:generateSyntheticData').replace( /([^:]\/)\/+/g, '$1' ), @@ -58161,24 +59108,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a CustomJob. + * Generates user scenarios for agent evaluation. * @example * ```js * // Before running the sample: @@ -58207,19 +59154,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.delete({ - * // Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * const res = await aiplatform.projects.locations.generateUserScenarios({ + * // Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agents": {}, + * // "allowCrossRegionModel": false, + * // "rootAgentId": "my_rootAgentId", + * // "userScenarioGenerationConfig": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "userScenarios": [] * // } * } * @@ -58235,57 +59189,61 @@ export namespace aiplatform_v1 { * @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$Customjobs$Delete, + generateUserScenarios( + params: Params$Resource$Projects$Locations$Generateuserscenarios, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Customjobs$Delete, + generateUserScenarios( + params?: Params$Resource$Projects$Locations$Generateuserscenarios, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateUserScenarios( + params: Params$Resource$Projects$Locations$Generateuserscenarios, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, + generateUserScenarios( + params: Params$Resource$Projects$Locations$Generateuserscenarios, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Delete, - callback: BodyResponseCallback + generateUserScenarios( + params: Params$Resource$Projects$Locations$Generateuserscenarios, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + generateUserScenarios( + callback: BodyResponseCallback ): void; - delete( + generateUserScenarios( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Generateuserscenarios + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Delete; + {}) as Params$Resource$Projects$Locations$Generateuserscenarios; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Generateuserscenarios; options = {}; } @@ -58298,29 +59256,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+location}:generateUserScenarios').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a CustomJob. + * Gets information about a location. * @example * ```js * // Before running the sample: @@ -58349,28 +59312,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.get({ - * // Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * const res = await aiplatform.projects.locations.get({ + * // Resource name for the location. + * name: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobSpec": {}, * // "labels": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "webAccessUris": {} + * // "locationId": "my_locationId", + * // "metadata": {}, + * // "name": "my_name" * // } * } * @@ -58387,60 +59341,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Customjobs$Get, + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, + params: Params$Resource$Projects$Locations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Customjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Get; + {}) as Params$Resource$Projects$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$Get; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -58465,19 +59415,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists CustomJobs in a Location. + * Gets a RagEngineConfig. * @example * ```js * // Before running the sample: @@ -58506,24 +59454,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.getRagEngineConfig({ + * // Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * name: 'projects/my-project/locations/my-location/ragEngineConfig', * }); * console.log(res.data); * * // Example response * // { - * // "customJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "name": "my_name", + * // "ragManagedDbConfig": {} * // } * } * @@ -58539,61 +59479,61 @@ export namespace aiplatform_v1 { * @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$Customjobs$List, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Customjobs$List, + getRagEngineConfig( + params?: Params$Resource$Projects$Locations$Getragengineconfig, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$List, - callback: BodyResponseCallback + getRagEngineConfig( + params: Params$Resource$Projects$Locations$Getragengineconfig, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getRagEngineConfig( + callback: BodyResponseCallback ): void; - list( + getRagEngineConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Getragengineconfig + | 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$Customjobs$List; + {}) as Params$Resource$Projects$Locations$Getragengineconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Customjobs$List; + params = {} as Params$Resource$Projects$Locations$Getragengineconfig; options = {}; } @@ -58606,98 +59546,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/customJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + 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$Projects$Locations$Customjobs$Cancel extends StandardParameters { - /** - * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; - } - export interface Params$Resource$Projects$Locations$Customjobs$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; - } - export interface Params$Resource$Projects$Locations$Customjobs$Delete extends StandardParameters { - /** - * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Customjobs$Get extends StandardParameters { - /** - * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Customjobs$List extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Customjobs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets a SemanticGovernancePolicyEngine. A SemanticGovernancePolicyEngine is a singleton resource that is created when its parent is created, and deleted when its parent is deleted. This method retrieves the current state of the Semantic Governance Policy Engine. * @example * ```js * // Before running the sample: @@ -58726,14 +59599,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.getSemanticGovernancePolicyEngine({ + * // Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicyEngine', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "gatewayConfigs": {}, + * // "ipAddress": "my_ipAddress", + * // "name": "my_name", + * // "pscForwardingRule": "my_pscForwardingRule", + * // "pscServiceAttachment": "my_pscServiceAttachment", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -58748,54 +59631,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + getSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + getSemanticGovernancePolicyEngine( + params?: Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + getSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, - callback: BodyResponseCallback + getSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + getSemanticGovernancePolicyEngine( + callback: BodyResponseCallback + ): void; + getSemanticGovernancePolicyEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine; options = {}; } @@ -58808,8 +59699,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -58820,17 +59711,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project\}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version. * @example * ```js * // Before running the sample: @@ -58859,14 +59752,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * const res = await aiplatform.projects.locations.list({ + * // Optional. Do not use this field 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', + * // The resource that owns the locations collection, if applicable. + * name: 'projects/my-project', + * // The maximum number of results to return. If not set, the service selects a default. + * pageSize: 'placeholder-value', + * // A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * pageToken: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "locations": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -58881,54 +59785,61 @@ export namespace aiplatform_v1 { * @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$Customjobs$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -58941,8 +59852,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -58953,17 +59867,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Retrieves relevant contexts for a query. * @example * ```js * // Before running the sample: @@ -58992,19 +59908,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * const res = await aiplatform.projects.locations.retrieveContexts({ + * // Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "vertexRagStore": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contexts": {} * // } * } * @@ -59020,58 +59941,61 @@ export namespace aiplatform_v1 { * @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$Customjobs$Operations$Get, + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + retrieveContexts( + params?: Params$Resource$Projects$Locations$Retrievecontexts, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, - callback: BodyResponseCallback + retrieveContexts( + params: Params$Resource$Projects$Locations$Retrievecontexts, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + retrieveContexts( + callback: BodyResponseCallback ): void; - get( + retrieveContexts( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Retrievecontexts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Retrievecontexts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Retrievecontexts; options = {}; } @@ -59084,29 +60008,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}:retrieveContexts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a RagEngineConfig. * @example * ```js * // Before running the sample: @@ -59135,25 +60064,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.updateRagEngineConfig({ + * // Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "name": "my_name", + * // "ragManagedDbConfig": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -59169,62 +60101,56 @@ export namespace aiplatform_v1 { * @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$Customjobs$Operations$List, + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, + updateRagEngineConfig( + params?: Params$Resource$Projects$Locations$Updateragengineconfig, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + ): Promise>; + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Customjobs$Operations$List, - callback: BodyResponseCallback + updateRagEngineConfig( + params: Params$Resource$Projects$Locations$Updateragengineconfig, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + updateRagEngineConfig( + callback: BodyResponseCallback ): void; - list( + updateRagEngineConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Updateragengineconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Updateragengineconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; + params = {} as Params$Resource$Projects$Locations$Updateragengineconfig; options = {}; } @@ -59237,11 +60163,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -59252,19 +60175,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a SemanticGovernancePolicyEngine. This method performs an upsert operation. If the SemanticGovernancePolicyEngine resource does not exist, it will be created. Otherwise, it will be updated. * @example * ```js * // Before running the sample: @@ -59293,12 +60214,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.customJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.updateSemanticGovernancePolicyEngine({ + * // Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicyEngine', + * // Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "gatewayConfigs": {}, + * // "ipAddress": "my_ipAddress", + * // "name": "my_name", + * // "pscForwardingRule": "my_pscForwardingRule", + * // "pscServiceAttachment": "my_pscServiceAttachment", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -59323,36 +60260,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + updateSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + updateSemanticGovernancePolicyEngine( + params?: Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + updateSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + updateSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, + updateSemanticGovernancePolicyEngine( + params: Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine, callback: BodyResponseCallback ): void; - wait( + updateSemanticGovernancePolicyEngine( callback: BodyResponseCallback ): void; - wait( + updateSemanticGovernancePolicyEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Customjobs$Operations$Wait + | Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59368,13 +60304,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine; options = {}; } @@ -59387,8 +60323,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -59409,76 +60345,219 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Askcontexts extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AskContextsRequest; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Asyncretrievecontexts extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AsyncRetrieveContextsRequest; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Augmentprompt extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AugmentPromptRequest; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Corroboratecontent extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. */ - filter?: string; + parent?: string; + /** - * The name of the operation's parent resource. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1CorroborateContentRequest; + } + export interface Params$Resource$Projects$Locations$Deploy extends StandardParameters { /** - * The standard list page size. + * Required. The resource name of the Location to deploy the model in. Format: `projects/{project\}/locations/{location\}` */ - pageSize?: number; + destination?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudAiplatformV1DeployRequest; + } + export interface Params$Resource$Projects$Locations$Evaluatedataset extends StandardParameters { /** - * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The resource name of the Location to evaluate the dataset. Format: `projects/{project\}/locations/{location\}` */ - returnPartialSuccess?: boolean; + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluateDatasetRequest; } - export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Evaluateinstances extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to evaluate the instances. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + location?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1EvaluateInstancesRequest; } + export interface Params$Resource$Projects$Locations$Generateinstancerubrics extends StandardParameters { + /** + * Required. The resource name of the Location to generate rubrics from. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; - export class Resource$Projects$Locations$Datalabelingjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datalabelingjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datalabelingjobs$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateInstanceRubricsRequest; + } + export interface Params$Resource$Projects$Locations$Generatelossclusters extends StandardParameters { + /** + * Required. The resource name of the Location. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; /** - * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com - * // - Login into gcloud by running: + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateLossClustersRequest; + } + export interface Params$Resource$Projects$Locations$Generatesyntheticdata extends StandardParameters { + /** + * Required. The geographic location where the synthetic data generation request is processed. This should be in the format `projects/{project\}/locations/{location\}`. For example, `projects/my-project/locations/us-central1`. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateSyntheticDataRequest; + } + export interface Params$Resource$Projects$Locations$Generateuserscenarios extends StandardParameters { + /** + * Required. The resource name of the Location to run the job. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateUserScenariosRequest; + } + export interface Params$Resource$Projects$Locations$Get extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Getragengineconfig extends StandardParameters { + /** + * Required. The name of the RagEngineConfig resource. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Getsemanticgovernancepolicyengine extends StandardParameters { + /** + * Required. The resource name of the SemanticGovernancePolicyEngine to retrieve. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List extends StandardParameters { + /** + * Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. + */ + extraLocationTypes?: string[]; + /** + * 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?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Retrievecontexts extends StandardParameters { + /** + * Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RetrieveContextsRequest; + } + export interface Params$Resource$Projects$Locations$Updateragengineconfig extends StandardParameters { + /** + * Identifier. The name of the RagEngineConfig. Format: `projects/{project\}/locations/{location\}/ragEngineConfig` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RagEngineConfig; + } + export interface Params$Resource$Projects$Locations$Updatesemanticgovernancepolicyengine extends StandardParameters { + /** + * Identifier. The resource name of the SemanticGovernancePolicyEngine. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + */ + name?: string; + /** + * Optional. Specifies the fields to be overwritten in the SemanticGovernancePolicyEngine resource by the update. The fields specified in the update_mask are relative to the resource itself. If no update_mask is provided, all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SemanticGovernancePolicyEngine; + } + + export class Resource$Projects$Locations$Agents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an agent. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.googleapis.com + * // - Login into gcloud by running: * // ```sh * // $ gcloud auth application-default login * // ``` @@ -59501,20 +60580,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.cancel({ - * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.projects.locations.agents.create({ + * // Required. The resource name of the location to create the agent in. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "base_agent": "my_base_agent", + * // "base_environment": {}, + * // "created": "my_created", + * // "description": "my_description", + * // "id": "my_id", + * // "metadata": {}, + * // "name": "my_name", + * // "object": "my_object", + * // "system_instruction": "my_system_instruction", + * // "tools": [], + * // "updated": "my_updated" + * // } * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -59529,54 +60626,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + create( + params: Params$Resource$Projects$Locations$Agents$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + create( + params?: Params$Resource$Projects$Locations$Agents$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Agents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Agents$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Agents$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Agents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; + params = {} as Params$Resource$Projects$Locations$Agents$Create; options = {}; } @@ -59589,29 +60688,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/agents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a DataLabelingJob. + * Deletes an agent. * @example * ```js * // Before running the sample: @@ -59640,57 +60742,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.create({ - * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, - * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, - * // "labels": {}, - * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.agents.delete({ + * // Required. The resource name of the agent to delete. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. + * name: 'projects/my-project/locations/my-location/agents/my-agent', * }); * console.log(res.data); * * // Example response * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, - * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, + * // "done": false, * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -59706,62 +60770,56 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Agents$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Agents$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Agents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Agents$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Agents$Delete, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - create( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + {}) as Params$Resource$Projects$Locations$Agents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; + params = {} as Params$Resource$Projects$Locations$Agents$Delete; options = {}; } @@ -59774,34 +60832,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a DataLabelingJob. + * Retrieves an agent. * @example * ```js * // Before running the sample: @@ -59830,19 +60883,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.delete({ - * // Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.projects.locations.agents.get({ + * // Required. The resource name of the agent to retrieve. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. + * name: 'projects/my-project/locations/my-location/agents/my-agent', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "base_agent": "my_base_agent", + * // "base_environment": {}, + * // "created": "my_created", + * // "description": "my_description", + * // "id": "my_id", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "object": "my_object", + * // "system_instruction": "my_system_instruction", + * // "tools": [], + * // "updated": "my_updated" * // } * } * @@ -59858,58 +60917,57 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Agents$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Agents$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Agents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Agents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Agents$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + {}) as Params$Resource$Projects$Locations$Agents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Agents$Get; options = {}; } @@ -59923,7 +60981,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -59934,17 +60992,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a DataLabelingJob. + * Lists agents in a location. * @example * ```js * // Before running the sample: @@ -59973,32 +61033,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.get({ - * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * const res = await aiplatform.projects.locations.agents.list({ + * // Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the location to list agents from. Format: `projects/{project\}/locations/{location\}`. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "activeLearningConfig": {}, - * // "annotationLabels": {}, - * // "createTime": "my_createTime", - * // "currentSpend": {}, - * // "datasets": [], - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "error": {}, - * // "inputs": {}, - * // "inputsSchemaUri": "my_inputsSchemaUri", - * // "instructionUri": "my_instructionUri", - * // "labelerCount": 0, - * // "labelingProgress": 0, - * // "labels": {}, - * // "name": "my_name", - * // "specialistPools": [], - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "agents": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -60014,61 +61064,61 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Get, + list( + params: Params$Resource$Projects$Locations$Agents$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Agents$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + list( + params: Params$Resource$Projects$Locations$Agents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + list( + params: Params$Resource$Projects$Locations$Agents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Agents$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$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$Datalabelingjobs$Get; + {}) as Params$Resource$Projects$Locations$Agents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; + params = {} as Params$Resource$Projects$Locations$Agents$List; options = {}; } @@ -60081,31 +61131,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/agents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, 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 ); } } /** - * Lists DataLabelingJobs in a Location. + * Updates an agent. * @example * ```js * // Before running the sample: @@ -60134,26 +61187,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.dataLabelingJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.agents.patch({ + * // Identifier. The resource name of the agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. + * name: 'projects/my-project/locations/my-location/agents/my-agent', + * // Optional. The list of fields to update. If not present, all fields are updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "base_agent": "my_base_agent", + * // "base_environment": {}, + * // "created": "my_created", + * // "description": "my_description", + * // "id": "my_id", + * // "metadata": {}, + * // "name": "my_name", + * // "object": "my_object", + * // "system_instruction": "my_system_instruction", + * // "tools": [], + * // "updated": "my_updated" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "dataLabelingJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "base_agent": "my_base_agent", + * // "base_environment": {}, + * // "created": "my_created", + * // "description": "my_description", + * // "id": "my_id", + * // "metadata": {}, + * // "name": "my_name", + * // "object": "my_object", + * // "system_instruction": "my_system_instruction", + * // "tools": [], + * // "updated": "my_updated" * // } * } * @@ -60169,61 +61241,57 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$List, + patch( + params: Params$Resource$Projects$Locations$Agents$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, + patch( + params?: Params$Resource$Projects$Locations$Agents$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Agents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + patch( + params: Params$Resource$Projects$Locations$Agents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Agents$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Agents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; + {}) as Params$Resource$Projects$Locations$Agents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; + params = {} as Params$Resource$Projects$Locations$Agents$Patch; options = {}; } @@ -60236,102 +61304,95 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + 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$Projects$Locations$Datalabelingjobs$Cancel extends StandardParameters { - /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Agents$Create extends StandardParameters { /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the location to create the agent in. Format: `projects/{project\}/locations/{location\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; + requestBody?: Schema$GoogleCloudAiplatformV1Agent; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Agents$Delete extends StandardParameters { /** - * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * Required. The resource name of the agent to delete. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Agents$Get extends StandardParameters { /** - * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * Required. The resource name of the agent to retrieve. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$List extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; + export interface Params$Resource$Projects$Locations$Agents$List extends StandardParameters { /** - * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * Optional. A comma-separated list of fields to order by. Supported fields: * `created` * `updated` Use `desc` after a field name for descending order. Example: `created desc`. */ orderBy?: string; /** - * The standard list page size. + * Optional. The maximum number of agents to return. The service may return fewer than this value. The maximum page size is 100; values above 100 will be coerced to 100. If unspecified, the default page size is 10. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token, received from a previous AgentService.ListAgents call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the location to list agents from. Format: `projects/{project\}/locations/{location\}`. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Agents$Patch extends StandardParameters { /** - * Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. + * Identifier. The resource name of the agent. Format: `projects/{project\}/locations/{location\}/agents/{agent\}`. */ - readMask?: string; + name?: string; + /** + * Optional. The list of fields to update. If not present, all fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Agent; } - export class Resource$Projects$Locations$Datalabelingjobs$Operations { + export class Resource$Projects$Locations$Batchpredictionjobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a BatchPredictionJob. Starts asynchronous cancellation on the BatchPredictionJob. The server makes the best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetBatchPredictionJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On a successful cancellation, the BatchPredictionJob is not deleted;instead its BatchPredictionJob.state is set to `CANCELLED`. Any files already outputted by the job are not deleted. * @example * ```js * // Before running the sample: @@ -60360,11 +61421,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.cancel({ + * // Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -60384,31 +61450,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60424,13 +61490,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel; options = {}; } @@ -60465,7 +61531,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a BatchPredictionJob. A BatchPredictionJob once created will right away be attempted to start. * @example * ```js * // Before running the sample: @@ -60494,15 +61560,80 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.create({ + * // Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -60517,54 +61648,62 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Create; options = {}; } @@ -60577,29 +61716,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a BatchPredictionJob. Can only be called on jobs that already finished. * @example * ```js * // Before running the sample: @@ -60628,11 +61772,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.delete({ + * // Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * }); * console.log(res.data); * * // Example response @@ -60657,36 +61800,35 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get + | Params$Resource$Projects$Locations$Batchpredictionjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60702,13 +61844,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Delete; options = {}; } @@ -60722,7 +61864,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -60743,7 +61885,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a BatchPredictionJob * @example * ```js * // Before running the sample: @@ -60772,26 +61914,43 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.get({ + * // Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` + * name: 'projects/my-project/locations/my-location/batchPredictionJobs/my-batchPredictionJob', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "completionStats": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "explanationSpec": {}, + * // "generateExplanation": false, + * // "inputConfig": {}, + * // "instanceConfig": {}, + * // "labels": {}, + * // "manualBatchTuningParameters": {}, + * // "model": "my_model", + * // "modelParameters": {}, + * // "modelVersionId": "my_modelVersionId", + * // "name": "my_name", + * // "outputConfig": {}, + * // "outputInfo": {}, + * // "partialFailures": [], + * // "resourcesConsumed": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "unmanagedContainerModel": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -60807,62 +61966,62 @@ export namespace aiplatform_v1 { * @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$Datalabelingjobs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$Get + | 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$Datalabelingjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$Get; options = {}; } @@ -60875,10 +62034,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -60890,19 +62046,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists BatchPredictionJobs in a Location. * @example * ```js * // Before running the sample: @@ -60931,22 +62087,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.dataLabelingJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.batchPredictionJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "batchPredictionJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -60962,58 +62120,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Batchpredictionjobs$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batchpredictionjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Batchpredictionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Batchpredictionjobs$List; options = {}; } @@ -61026,105 +62188,98 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/batchPredictionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Cancel extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the BatchPredictionJob to cancel. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelBatchPredictionJobRequest; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location to create the BatchPredictionJob in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchPredictionJob; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Delete extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the BatchPredictionJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$Get extends StandardParameters { /** - * The standard list filter. + * Required. The name of the BatchPredictionJob resource. Format: `projects/{project\}/locations/{location\}/batchPredictionJobs/{batch_prediction_job\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Batchpredictionjobs$List extends StandardParameters { /** - * The name of the operation's parent resource. + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `model_display_name` supports `=`, `!=` comparisons. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ - name?: string; + filter?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListBatchPredictionJobsResponse.next_page_token of the previous JobService.ListBatchPredictionJobs call. */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the BatchPredictionJobs from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Datasets { + export class Resource$Projects$Locations$Cachedcontents { context: APIRequestContext; - annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; - dataItems: Resource$Projects$Locations$Datasets$Dataitems; - datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; - operations: Resource$Projects$Locations$Datasets$Operations; - savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; constructor(context: APIRequestContext) { this.context = context; - this.annotationSpecs = - new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); - this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( - this.context - ); - this.datasetVersions = - new Resource$Projects$Locations$Datasets$Datasetversions(this.context); - this.operations = new Resource$Projects$Locations$Datasets$Operations( - this.context - ); - this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( - this.context - ); } /** - * Creates a Dataset. + * Creates cached content, this call will initialize the cached content in the data storage, and users need to pay for the cache data storage. * @example * ```js * // Before running the sample: @@ -61153,30 +62308,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.create({ - * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.cachedContents.create({ + * // Required. The parent resource where the cached content will be created * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "contents": [], * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", + * // "expireTime": "my_expireTime", + * // "model": "my_model", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * }, * }); @@ -61184,11 +62336,19 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", * // "name": "my_name", - * // "response": {} + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * } * @@ -61205,56 +62365,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datasets$Create, + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Datasets$Create, + params?: Params$Resource$Projects$Locations$Cachedcontents$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Datasets$Create, + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Create, + params: Params$Resource$Projects$Locations$Cachedcontents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cachedcontents$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Create; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Create; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Create; options = {}; } @@ -61267,7 +62431,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( + url: (rootUrl + '/v1/{+parent}/cachedContents').replace( /([^:]\/)\/+/g, '$1' ), @@ -61282,17 +62446,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Dataset. + * Deletes cached content * @example * ```js * // Before running the sample: @@ -61321,20 +62487,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.delete({ - * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.projects.locations.cachedContents.delete({ + * // Required. The resource name referring to the cached content + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -61350,56 +62510,52 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Delete, + params?: Params$Resource$Projects$Locations$Cachedcontents$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cachedcontents$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Delete; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Delete; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Delete; options = {}; } @@ -61424,17 +62580,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Exports data from a Dataset. + * Gets cached content configurations * @example * ```js * // Before running the sample: @@ -61463,27 +62619,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.export({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "exportConfig": {} - * // } - * }, + * const res = await aiplatform.projects.locations.cachedContents.get({ + * // Required. The resource name referring to the cached content + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", * // "name": "my_name", - * // "response": {} + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * } * @@ -61499,57 +62655,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + get( + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: StreamMethodOptions ): Promise>; - export( - params?: Params$Resource$Projects$Locations$Datasets$Export, + get( + params?: Params$Resource$Projects$Locations$Cachedcontents$Get, options?: MethodOptions - ): Promise>; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, + get( + params: Params$Resource$Projects$Locations$Cachedcontents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Datasets$Export, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Cachedcontents$Get, + callback: BodyResponseCallback ): void; - export( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - export( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Export - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Export; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Export; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Get; options = {}; } @@ -61562,8 +62722,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -61574,17 +62734,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Dataset. + * Lists cached contents in a project * @example * ```js * // Before running the sample: @@ -61613,32 +62775,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.get({ - * // Required. The name of the Dataset resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.cachedContents.list({ + * // Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent, which owns this collection of cached contents. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "cachedContents": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -61654,57 +62804,61 @@ export namespace aiplatform_v1 { * @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$Datasets$Get, + list( + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Get, + list( + params?: Params$Resource$Projects$Locations$Cachedcontents$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, + list( + params: Params$Resource$Projects$Locations$Cachedcontents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Cachedcontents$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Get; + {}) as Params$Resource$Projects$Locations$Cachedcontents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Get; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$List; options = {}; } @@ -61717,31 +62871,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/cachedContents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, 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 ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Updates cached content configurations * @example * ```js * // Before running the sample: @@ -61770,19 +62927,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.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/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.projects.locations.cachedContents.patch({ + * // Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} + * name: 'projects/my-project/locations/my-location/cachedContents/my-cachedContent', + * // Required. The list of fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "contents": [], + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "expireTime": "my_expireTime", + * // "model": "my_model", + * // "name": "my_name", + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "usageMetadata": {} * // } * } * @@ -61798,55 +62985,61 @@ export namespace aiplatform_v1 { * @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$Locations$Datasets$Getiampolicy, + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Cachedcontents$Patch, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Cachedcontents$Patch, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - getIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Cachedcontents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Cachedcontents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Cachedcontents$Patch; options = {}; } @@ -61859,32 +63052,95 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Create extends StandardParameters { /** - * Imports data into a Dataset. + * Required. The parent resource where the cached content will be created + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Delete extends StandardParameters { + /** + * Required. The resource name referring to the cached content + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Get extends StandardParameters { + /** + * Required. The resource name referring to the cached content + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$List extends StandardParameters { + /** + * Optional. The maximum number of cached contents to return. The service may return fewer than this value. If unspecified, some default (under maximum) number of items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListCachedContents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCachedContents` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of cached contents. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Cachedcontents$Patch extends StandardParameters { + /** + * Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project\}/locations/{location\}/cachedContents/{cached_content\} + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CachedContent; + } + + export class Resource$Projects$Locations$Customjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Customjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Customjobs$Operations( + this.context + ); + } + + /** + * Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and CustomJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -61913,28 +63169,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.import({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.projects.locations.customJobs.cancel({ + * // Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "importConfigs": [] - * // } + * // {} * }, * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -61949,57 +63197,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Datasets$Import, + cancel( + params?: Params$Resource$Projects$Locations$Customjobs$Cancel, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datasets$Import, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Customjobs$Cancel, + callback: BodyResponseCallback ): void; - import( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Import; + {}) as Params$Resource$Projects$Locations$Customjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Import; + params = {} as Params$Resource$Projects$Locations$Customjobs$Cancel; options = {}; } @@ -62012,7 +63256,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -62024,17 +63268,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Datasets in a Location. + * Creates a CustomJob. A created CustomJob right away will be attempted to be run. * @example * ```js * // Before running the sample: @@ -62063,26 +63307,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.list({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.customJobs.create({ + * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "datasets": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} * // } * } * @@ -62098,61 +63365,61 @@ export namespace aiplatform_v1 { * @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$Datasets$List, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$List, + create( + params?: Params$Resource$Projects$Locations$Customjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Customjobs$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Create + | 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$Datasets$List; + {}) as Params$Resource$Projects$Locations$Customjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$List; + params = {} as Params$Resource$Projects$Locations$Customjobs$Create; options = {}; } @@ -62165,11 +63432,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasets').replace( + url: (rootUrl + '/v1/{+parent}/customJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -62180,19 +63447,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Dataset. + * Deletes a CustomJob. * @example * ```js * // Before running the sample: @@ -62221,55 +63488,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.patch({ - * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.customJobs.delete({ + * // Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataItemCount": "my_dataItemCount", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "savedQueries": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -62285,57 +63516,56 @@ export namespace aiplatform_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$Datasets$Patch, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Patch, + delete( + params?: Params$Resource$Projects$Locations$Customjobs$Delete, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Customjobs$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Patch; + {}) as Params$Resource$Projects$Locations$Customjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Patch; + params = {} as Params$Resource$Projects$Locations$Customjobs$Delete; options = {}; } @@ -62349,7 +63579,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -62360,19 +63590,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Searches DataItems in a Dataset. + * Gets a CustomJob. * @example * ```js * // Before running the sample: @@ -62401,42 +63629,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.searchDataItems({ - * // An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. - * annotationFilters: 'placeholder-value', - * // An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. - * annotationsFilter: 'placeholder-value', - * // If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. - * annotationsLimit: 'placeholder-value', - * // An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` - * dataItemFilter: 'placeholder-value', - * // The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. - * dataLabelingJob: 'placeholder-value', - * // Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * dataset: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields of DataItemView to read. - * fieldMask: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. - * 'orderByAnnotation.orderBy': 'placeholder-value', - * // Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. - * 'orderByAnnotation.savedQuery': 'placeholder-value', - * // A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderByDataItem: 'placeholder-value', - * // Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. - * pageSize: 'placeholder-value', - * // A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. - * pageToken: 'placeholder-value', - * // The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. - * savedQuery: 'placeholder-value', + * const res = await aiplatform.projects.locations.customJobs.get({ + * // Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', * }); * console.log(res.data); * * // Example response * // { - * // "dataItemViews": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobSpec": {}, + * // "labels": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "webAccessUris": {} * // } * } * @@ -62452,62 +63666,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, options: StreamMethodOptions ): Promise>; - searchDataItems( - params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + get( + params?: Params$Resource$Projects$Locations$Customjobs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchDataItems( - params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Customjobs$Get, + callback: BodyResponseCallback ): void; - searchDataItems( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - searchDataItems( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Searchdataitems - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$Get + | 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$Datasets$Searchdataitems; + {}) as Params$Resource$Projects$Locations$Customjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; + params = {} as Params$Resource$Projects$Locations$Customjobs$Get; options = {}; } @@ -62520,34 +63733,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['dataset'], - pathParams: ['dataset'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists CustomJobs in a Location. * @example * ```js * // Before running the sample: @@ -62576,25 +63786,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.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/locations/my-location/datasets/my-dataset', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * const res = await aiplatform.projects.locations.customJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "customJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -62610,55 +63819,61 @@ export namespace aiplatform_v1 { * @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$Locations$Datasets$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Customjobs$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Customjobs$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Customjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Customjobs$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Customjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Customjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Customjobs$List; options = {}; } @@ -62671,259 +63886,82 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/customJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Customjobs$Cancel extends StandardParameters { /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/datasets/my-dataset', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "permissions": [] - * // } - * } - * - * 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. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: StreamMethodOptions - ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').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$Locations$Datasets$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the CustomJob to cancel. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Delete extends StandardParameters { - /** - * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1CancelCustomJobRequest; } - export interface Params$Resource$Projects$Locations$Datasets$Export extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Create extends StandardParameters { /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; + requestBody?: Schema$GoogleCloudAiplatformV1CustomJob; } - export interface Params$Resource$Projects$Locations$Datasets$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Delete extends StandardParameters { /** - * Required. The name of the Dataset resource. + * Required. The name of the CustomJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$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$Locations$Datasets$Import extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Get extends StandardParameters { /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * Required. The name of the CustomJob resource. Format: `projects/{project\}/locations/{location\}/customJobs/{custom_job\}` */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; } - export interface Params$Resource$Projects$Locations$Datasets$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$List extends StandardParameters { /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` - */ - orderBy?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListCustomJobsResponse.next_page_token of the previous JobService.ListCustomJobs call. */ pageToken?: string; /** - * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list the CustomJobs from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** @@ -62931,276 +63969,8 @@ export namespace aiplatform_v1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { - /** - * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Dataset; - } - export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems extends StandardParameters { - /** - * An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. - */ - annotationFilters?: string[]; - /** - * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. - */ - annotationsFilter?: string; - /** - * If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. - */ - annotationsLimit?: number; - /** - * An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` - */ - dataItemFilter?: string; - /** - * The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. - */ - dataLabelingJob?: string; - /** - * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - dataset?: string; - /** - * Mask specifying which fields of DataItemView to read. - */ - fieldMask?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. - */ - 'orderByAnnotation.orderBy'?: string; - /** - * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. - */ - 'orderByAnnotation.savedQuery'?: string; - /** - * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderByDataItem?: string; - /** - * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. - */ - pageSize?: number; - /** - * A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. - */ - pageToken?: string; - /** - * The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. - */ - savedQuery?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Datasets$Annotationspecs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( - this.context - ); - } - - /** - * Gets an AnnotationSpec. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.annotationSpecs.get({ - * // Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "name": "my_name", - * // "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$Datasets$Annotationspecs$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.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 - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get extends StandardParameters { - /** - * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` - */ - name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { + export class Resource$Projects$Locations$Customjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -63236,13 +64006,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -63262,31 +64029,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel + | Params$Resource$Projects$Locations$Customjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63302,13 +64069,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Cancel; options = {}; } @@ -63372,13 +64139,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -63398,31 +64162,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete + | Params$Resource$Projects$Locations$Customjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63438,13 +64202,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Delete; options = {}; } @@ -63508,13 +64272,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -63540,27 +64301,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -63568,7 +64328,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get + | Params$Resource$Projects$Locations$Customjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63584,13 +64344,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Get; options = {}; } @@ -63654,21 +64414,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -63692,29 +64449,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, + params: Params$Resource$Projects$Locations$Customjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -63722,7 +64479,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List + | Params$Resource$Projects$Locations$Customjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63740,13 +64497,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$List; options = {}; } @@ -63815,15 +64572,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.annotationSpecs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.customJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/customJobs/my-customJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -63849,27 +64603,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, + params: Params$Resource$Projects$Locations$Customjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -63877,7 +64630,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait + | Params$Resource$Projects$Locations$Customjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -63893,13 +64646,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Customjobs$Operations$Wait; options = {}; } @@ -63934,25 +64687,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -63974,7 +64727,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Customjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -63985,24 +64738,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems { + export class Resource$Projects$Locations$Datalabelingjobs { context: APIRequestContext; - annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; - operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; + operations: Resource$Projects$Locations$Datalabelingjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.annotations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations( - this.context - ); this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Operations( + new Resource$Projects$Locations$Datalabelingjobs$Operations( this.context ); } /** - * Lists DataItems in a Dataset. + * Cancels a DataLabelingJob. Success of cancellation is not guaranteed. * @example * ```js * // Before running the sample: @@ -64031,27 +64779,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.dataItems.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.dataLabelingJobs.cancel({ + * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "dataItems": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -64066,62 +64807,54 @@ export namespace aiplatform_v1 { * @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$Datasets$Dataitems$List, + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + cancel( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Cancel; options = {}; } @@ -64134,73 +64867,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( - this.context - ); - } /** - * Lists Annotations belongs to a dataitem. + * Creates a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -64229,28 +64918,57 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` - * parent: - * 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.dataLabelingJobs.create({ + * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, + * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, + * // "labels": {}, + * // "name": "my_name", + * // "specialistPools": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "annotations": [], - * // "nextPageToken": "my_nextPageToken" + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, + * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, + * // "labels": {}, + * // "name": "my_name", + * // "specialistPools": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -64266,62 +64984,62 @@ export namespace aiplatform_v1 { * @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$Datasets$Dataitems$Annotations$List, + create( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + create( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + create( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + create( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Create + | 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$Datasets$Dataitems$Annotations$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Create; options = {}; } @@ -64334,11 +65052,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/annotations').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -64349,53 +65067,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -64424,17 +65108,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.dataLabelingJobs.delete({ + * // Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -64449,190 +65136,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datalabelingjobs$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:cancel').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); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); - * console.log(res.data); - * - * // Example 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$Datasets$Dataitems$Annotations$Operations$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Delete; options = {}; } @@ -64657,17 +65211,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a DataLabelingJob. * @example * ```js * // Before running the sample: @@ -64696,22 +65250,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.dataLabelingJobs.get({ + * // Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "activeLearningConfig": {}, + * // "annotationLabels": {}, + * // "createTime": "my_createTime", + * // "currentSpend": {}, + * // "datasets": [], + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "error": {}, - * // "metadata": {}, + * // "inputs": {}, + * // "inputsSchemaUri": "my_inputsSchemaUri", + * // "instructionUri": "my_instructionUri", + * // "labelerCount": 0, + * // "labelingProgress": 0, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "specialistPools": [], + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -64728,57 +65292,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$Get; options = {}; } @@ -64803,17 +65370,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists DataLabelingJobs in a Location. * @example * ```js * // Before running the sample: @@ -64842,28 +65411,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.dataLabelingJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "dataLabelingJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -64880,61 +65447,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datalabelingjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datalabelingjobs$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$Datasets$Dataitems$Annotations$Operations$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Datalabelingjobs$List; options = {}; } @@ -64947,7 +65513,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/dataLabelingJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -64957,198 +65523,66 @@ export namespace aiplatform_v1 { 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$Datalabelingjobs$Cancel extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); - * 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. + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ - wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, - options: StreamMethodOptions - ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, - options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + name?: string; - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').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); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelDataLabelingJobRequest; } + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Create extends StandardParameters { + /** + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1DataLabelingJob; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the DataLabelingJob to be deleted. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$List extends StandardParameters { /** - * The standard list filter. + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. */ - name?: string; + orderBy?: string; /** * The standard list page size. */ @@ -65158,22 +65592,16 @@ export namespace aiplatform_v1 { */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The parent of the DataLabelingJob. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. FieldMask represents a set of symbolic field paths. For example, the mask can be `paths: "name"`. The "name" here is a field in DataLabelingJob. If this field is not set, all fields of the DataLabelingJob are returned. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Datasets$Dataitems$Operations { + export class Resource$Projects$Locations$Datalabelingjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -65210,9 +65638,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.cancel({ + * await aiplatform.projects.locations.dataLabelingJobs.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * @@ -65233,31 +65661,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65273,13 +65701,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel; options = {}; } @@ -65344,9 +65772,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.delete({ + * await aiplatform.projects.locations.dataLabelingJobs.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * @@ -65367,31 +65795,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65407,13 +65835,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete; options = {}; } @@ -65478,9 +65906,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.get({ + * await aiplatform.projects.locations.dataLabelingJobs.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * }); * console.log(res.data); * @@ -65507,27 +65935,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -65535,7 +65962,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65551,13 +65978,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get; options = {}; } @@ -65622,11 +66049,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.list({ + * await aiplatform.projects.locations.dataLabelingJobs.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -65657,29 +66084,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -65687,7 +66114,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65705,13 +66132,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List; options = {}; } @@ -65781,9 +66208,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.dataItems.operations.wait({ + * await aiplatform.projects.locations.dataLabelingJobs.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * name: 'projects/my-project/locations/my-location/dataLabelingJobs/my-dataLabelingJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -65812,27 +66239,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, + params: Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -65840,7 +66266,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait + | Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -65856,13 +66282,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait; options = {}; } @@ -65897,25 +66323,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -65937,7 +66363,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datalabelingjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -65948,14 +66374,32 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Datasetversions { + export class Resource$Projects$Locations$Datasets { context: APIRequestContext; + annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; + dataItems: Resource$Projects$Locations$Datasets$Dataitems; + datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; + operations: Resource$Projects$Locations$Datasets$Operations; + savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; constructor(context: APIRequestContext) { this.context = context; + this.annotationSpecs = + new Resource$Projects$Locations$Datasets$Annotationspecs(this.context); + this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( + this.context + ); + this.datasetVersions = + new Resource$Projects$Locations$Datasets$Datasetversions(this.context); + this.operations = new Resource$Projects$Locations$Datasets$Operations( + this.context + ); + this.savedQueries = new Resource$Projects$Locations$Datasets$Savedqueries( + this.context + ); } /** - * Create a version from a Dataset. + * Creates a Dataset. * @example * ```js * // Before running the sample: @@ -65984,28 +66428,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.create({ - * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.projects.locations.datasets.create({ + * // Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -66031,27 +66480,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params?: Params$Resource$Projects$Locations$Datasets$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + params: Params$Resource$Projects$Locations$Datasets$Create, callback: BodyResponseCallback ): void; create( @@ -66059,7 +66507,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | Params$Resource$Projects$Locations$Datasets$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66075,13 +66523,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + params = {} as Params$Resource$Projects$Locations$Datasets$Create; options = {}; } @@ -66094,7 +66541,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + url: (rootUrl + '/v1/{+parent}/datasets').replace( /([^:]\/)\/+/g, '$1' ), @@ -66119,7 +66566,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a Dataset version. + * Deletes a Dataset. * @example * ```js * // Before running the sample: @@ -66148,11 +66595,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.delete({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * }); + * const res = await aiplatform.projects.locations.datasets.delete({ + * // Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * }); * console.log(res.data); * * // Example response @@ -66178,27 +66624,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + params: Params$Resource$Projects$Locations$Datasets$Delete, callback: BodyResponseCallback ): void; delete( @@ -66206,7 +66651,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | Params$Resource$Projects$Locations$Datasets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66222,13 +66667,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + params = {} as Params$Resource$Projects$Locations$Datasets$Delete; options = {}; } @@ -66263,7 +66707,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Dataset version. + * Exports data from a Dataset. * @example * ```js * // Before running the sample: @@ -66292,26 +66736,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.datasetVersions.get({ - * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.datasets.export({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "exportConfig": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -66327,62 +66772,56 @@ export namespace aiplatform_v1 { * @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$Datasets$Datasetversions$Get, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + export( + params?: Params$Resource$Projects$Locations$Datasets$Export, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + ): Promise>; + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + export( + params: Params$Resource$Projects$Locations$Datasets$Export, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, - callback: BodyResponseCallback + export( + params: Params$Resource$Projects$Locations$Datasets$Export, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + export( + callback: BodyResponseCallback ): void; - get( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Export + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + params = {} as Params$Resource$Projects$Locations$Datasets$Export; options = {}; } @@ -66395,8 +66834,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -66407,19 +66846,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists DatasetVersions in a Dataset. + * Gets a Dataset. * @example * ```js * // Before running the sample: @@ -66448,28 +66885,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.datasetVersions.list( - * { - * // Optional. The standard list filter. - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.get({ + * // Required. The name of the Dataset resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "datasetVersions": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -66485,62 +66926,57 @@ export namespace aiplatform_v1 { * @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$Datasets$Datasetversions$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + get( + params?: Params$Resource$Projects$Locations$Datasets$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + {}) as Params$Resource$Projects$Locations$Datasets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + params = {} as Params$Resource$Projects$Locations$Datasets$Get; options = {}; } @@ -66553,34 +66989,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DatasetVersion. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -66609,44 +67042,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.patch({ - * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.datasets.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/locations/my-location/datasets/my-dataset', + * }); * console.log(res.data); * * // Example response * // { - * // "bigQueryDatasetName": "my_bigQueryDatasetName", - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", + * // "bindings": [], * // "etag": "my_etag", - * // "metadata": {}, - * // "modelReference": "my_modelReference", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "version": 0 * // } * } * @@ -66662,62 +67070,55 @@ export namespace aiplatform_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$Datasets$Datasetversions$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Getiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - patch( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; + params = {} as Params$Resource$Projects$Locations$Datasets$Getiampolicy; options = {}; } @@ -66730,31 +67131,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Restores a dataset version. + * Imports data into a Dataset. * @example * ```js * // Before running the sample: @@ -66783,11 +67185,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.datasets.datasetVersions.restore({ - * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', - * }); + * const res = await aiplatform.projects.locations.datasets.import({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "importConfigs": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -66812,36 +67221,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions ): Promise>; - restore( - params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + import( + params?: Params$Resource$Projects$Locations$Datasets$Import, options?: MethodOptions ): Promise>; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - restore( - params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + import( + params: Params$Resource$Projects$Locations$Datasets$Import, callback: BodyResponseCallback ): void; - restore( + import( callback: BodyResponseCallback ): void; - restore( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | Params$Resource$Projects$Locations$Datasets$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -66857,13 +67265,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + {}) as Params$Resource$Projects$Locations$Datasets$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + params = {} as Params$Resource$Projects$Locations$Datasets$Import; options = {}; } @@ -66876,11 +67283,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:restore').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:import').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -66899,91 +67303,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create extends StandardParameters { - /** - * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; - } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete extends StandardParameters { - /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get extends StandardParameters { - /** - * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List extends StandardParameters { - /** - * Optional. The standard list filter. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch extends StandardParameters { - /** - * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; - } - export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore extends StandardParameters { - /** - * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datasets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists Datasets in a Location. * @example * ```js * // Before running the sample: @@ -67012,14 +67334,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * const res = await aiplatform.projects.locations.datasets.list({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "datasets": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -67034,54 +67369,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Datasets$List, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Datasets$List; options = {}; } @@ -67094,29 +67436,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/datasets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Updates a Dataset. * @example * ```js * // Before running the sample: @@ -67145,14 +67492,56 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * const res = await aiplatform.projects.locations.datasets.patch({ + * // Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "dataItemCount": "my_dataItemCount", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "savedQueries": [], + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -67167,54 +67556,57 @@ export namespace aiplatform_v1 { * @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$Datasets$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Datasets$Patch; options = {}; } @@ -67228,7 +67620,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -67239,17 +67631,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Searches DataItems in a Dataset. * @example * ```js * // Before running the sample: @@ -67278,19 +67672,42 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * const res = await aiplatform.projects.locations.datasets.searchDataItems({ + * // An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. + * annotationFilters: 'placeholder-value', + * // An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. + * annotationsFilter: 'placeholder-value', + * // If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. + * annotationsLimit: 'placeholder-value', + * // An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` + * dataItemFilter: 'placeholder-value', + * // The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. + * dataLabelingJob: 'placeholder-value', + * // Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * dataset: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields of DataItemView to read. + * fieldMask: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. + * 'orderByAnnotation.orderBy': 'placeholder-value', + * // Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. + * 'orderByAnnotation.savedQuery': 'placeholder-value', + * // A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderByDataItem: 'placeholder-value', + * // Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. + * pageSize: 'placeholder-value', + * // A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. + * pageToken: 'placeholder-value', + * // The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. + * savedQuery: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dataItemViews": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -67306,58 +67723,62 @@ export namespace aiplatform_v1 { * @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$Datasets$Operations$Get, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + searchDataItems( + params?: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - callback: BodyResponseCallback + searchDataItems( + params: Params$Resource$Projects$Locations$Datasets$Searchdataitems, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchDataItems( + callback: BodyResponseCallback ): void; - get( + searchDataItems( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Searchdataitems + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Searchdataitems; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Searchdataitems; options = {}; } @@ -67370,29 +67791,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+dataset}:searchDataItems').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataset'], + pathParams: ['dataset'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -67421,25 +67847,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.datasets.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/locations/my-location/datasets/my-dataset', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -67455,62 +67881,55 @@ export namespace aiplatform_v1 { * @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$Datasets$Operations$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Operations$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datasets$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Operations$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Datasets$Setiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - list( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$List; + params = {} as Params$Resource$Projects$Locations$Datasets$Setiampolicy; options = {}; } @@ -67523,34 +67942,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -67579,21 +67996,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.datasets.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/datasets/my-dataset', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -67609,58 +68022,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Datasets$Testiampermissions, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - wait( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Testiampermissions; options = {}; } @@ -67673,235 +68090,226 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the Dataset in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Dataset to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Export extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Operations$List extends StandardParameters { + /** - * The standard list filter. + * Request body metadata */ - filter?: string; + requestBody?: Schema$GoogleCloudAiplatformV1ExportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Get extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. The name of the Dataset resource. */ name?: string; /** - * The standard list page size. + * Mask specifying which fields to read. */ - pageSize?: number; + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Getiampolicy extends StandardParameters { /** - * The standard list page token. + * 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). */ - pageToken?: string; + 'options.requestedPolicyVersion'?: number; /** - * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * 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. */ - returnPartialSuccess?: boolean; + resource?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Import extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1ImportDataRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$List extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `display_name`: supports = and != * `metadata_schema_uri`: supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `displayName="myDisplayName"` * `labels.myKey="myValue"` + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The name of the Dataset's parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { + /** + * Output only. Identifier. The resource name of the Dataset. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` * `description` * `labels` + */ + updateMask?: string; - export class Resource$Projects$Locations$Datasets$Savedqueries { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Dataset; + } + export interface Params$Resource$Projects$Locations$Datasets$Searchdataitems extends StandardParameters { + /** + * An expression that specifies what Annotations will be returned per DataItem. Annotations satisfied either of the conditions will be returned. * `annotation_spec_id` - for = or !=. Must specify `saved_query_id=` - saved query id that annotations should belong to. + */ + annotationFilters?: string[]; + /** + * An expression for filtering the Annotations that will be returned per DataItem. * `annotation_spec_id` - for = or !=. + */ + annotationsFilter?: string; + /** + * If set, only up to this many of Annotations will be returned per DataItemView. The maximum value is 1000. If not set, the maximum value will be used. + */ + annotationsLimit?: number; + /** + * An expression for filtering the DataItem that will be returned. * `data_item_id` - for = or !=. * `labeled` - for = or !=. * `has_annotation(ANNOTATION_SPEC_ID)` - true only for DataItem that have at least one annotation with annotation_spec_id = `ANNOTATION_SPEC_ID` in the context of SavedQuery or DataLabelingJob. For example: * `data_item=1` * `has_annotation(5)` + */ + dataItemFilter?: string; + /** + * The resource name of a DataLabelingJob. Format: `projects/{project\}/locations/{location\}/dataLabelingJobs/{data_labeling_job\}` If this field is set, all of the search will be done in the context of this DataLabelingJob. + */ + dataLabelingJob?: string; + /** + * Required. The resource name of the Dataset from which to search DataItems. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + dataset?: string; + /** + * Mask specifying which fields of DataItemView to read. + */ + fieldMask?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * A comma-separated list of annotation fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Must also specify saved_query. + */ + 'orderByAnnotation.orderBy'?: string; + /** + * Required. Saved query of the Annotation. Only Annotations belong to this saved query will be considered for ordering. + */ + 'orderByAnnotation.savedQuery'?: string; + /** + * A comma-separated list of data item fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderByDataItem?: string; + /** + * Requested page size. Server may return fewer results than requested. Default and maximum page size is 100. + */ + pageSize?: number; + /** + * A token identifying a page of results for the server to return Typically obtained via SearchDataItemsResponse.next_page_token of the previous DatasetService.SearchDataItems call. + */ + pageToken?: string; + /** + * The resource name of a SavedQuery(annotation set in UI). Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` All of the search will be done in the context of this SavedQuery. + */ + savedQuery?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$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$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datasets$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Datasets$Annotationspecs { context: APIRequestContext; - operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; + operations: Resource$Projects$Locations$Datasets$Annotationspecs$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Datasets$Savedqueries$Operations( + new Resource$Projects$Locations$Datasets$Annotationspecs$Operations( this.context ); } /** - * Deletes a SavedQuery. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.savedQueries.delete({ - * // Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', - * }); - * 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$Datasets$Savedqueries$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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); - } - } - - /** - * Lists SavedQueries in a Dataset. + * Gets an AnnotationSpec. * @example * ```js * // Before running the sample: @@ -67930,17 +68338,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.datasets.savedQueries.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * const res = await aiplatform.projects.locations.datasets.annotationSpecs.get({ + * // Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', * // Mask specifying which fields to read. * readMask: 'placeholder-value', * }); @@ -67948,8 +68348,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "savedQueries": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "name": "my_name", + * // "updateTime": "my_updateTime" * // } * } * @@ -67965,62 +68368,62 @@ export namespace aiplatform_v1 { * @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$Datasets$Savedqueries$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + get( + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get + | 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$Datasets$Savedqueries$List; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get; options = {}; } @@ -68033,67 +68436,42 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/savedQueries').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + 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$Projects$Locations$Datasets$Savedqueries$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Get extends StandardParameters { /** - * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` + * Required. The name of the AnnotationSpec resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/annotationSpecs/{annotation_spec\}` */ name?: string; - } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` - */ - parent?: string; /** * Mask specifying which fields to read. */ readMask?: string; } - export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { + export class Resource$Projects$Locations$Datasets$Annotationspecs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -68130,10 +68508,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.cancel( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }, * ); * console.log(res.data); @@ -68155,31 +68533,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68195,13 +68573,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel; options = {}; } @@ -68266,10 +68644,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.delete( + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', * }, * ); * console.log(res.data); @@ -68291,31 +68669,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68331,13 +68709,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete; options = {}; } @@ -68402,10 +68780,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * }); + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -68431,27 +68811,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -68459,7 +68838,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68475,13 +68854,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get; options = {}; } @@ -68546,18 +68925,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -68581,29 +68962,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -68611,7 +68992,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68629,13 +69010,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List; options = {}; } @@ -68705,12 +69086,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.datasets.savedQueries.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.datasets.annotationSpecs.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/annotationSpecs/my-annotationSpec/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -68736,27 +69119,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -68764,7 +69146,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -68780,13 +69162,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait; options = {}; } @@ -68821,25 +69203,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -68861,7 +69243,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Annotationspecs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -68872,19 +69254,24 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Deploymentresourcepools { + export class Resource$Projects$Locations$Datasets$Dataitems { context: APIRequestContext; - operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; + annotations: Resource$Projects$Locations$Datasets$Dataitems$Annotations; + operations: Resource$Projects$Locations$Datasets$Dataitems$Operations; constructor(context: APIRequestContext) { this.context = context; + this.annotations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations( + this.context + ); this.operations = - new Resource$Projects$Locations$Deploymentresourcepools$Operations( + new Resource$Projects$Locations$Datasets$Dataitems$Operations( this.context ); } /** - * Create a DeploymentResourcePool. + * Lists DataItems in a Dataset. * @example * ```js * // Before running the sample: @@ -68913,29 +69300,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.deploymentResourcePools.create({ - * // Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deploymentResourcePool": {}, - * // "deploymentResourcePoolId": "my_deploymentResourcePoolId" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.datasets.dataItems.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "dataItems": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -68951,58 +69335,62 @@ export namespace aiplatform_v1 { * @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$Deploymentresourcepools$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$List; options = {}; } @@ -69015,11 +69403,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( + url: (rootUrl + '/v1/{+parent}/dataItems').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -69030,17 +69418,58 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$List extends StandardParameters { /** - * Delete a DeploymentResourcePool. + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DataItems from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations( + this.context + ); + } + + /** + * Lists Annotations belongs to a dataitem. * @example * ```js * // Before running the sample: @@ -69070,19 +69499,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.delete({ - * // Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * await aiplatform.projects.locations.datasets.dataItems.annotations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + * parent: + * 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "annotations": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -69098,58 +69535,62 @@ export namespace aiplatform_v1 { * @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$Deploymentresourcepools$Delete, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List; options = {}; } @@ -69162,29 +69603,68 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/annotations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$List extends StandardParameters { /** - * Get a DeploymentResourcePool. + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataItem to list Annotations from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/dataItems/{data_item\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -69213,23 +69693,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.get({ - * // Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * }); + * const res = + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount" - * // } + * // {} * } * * main().catch(e => { @@ -69244,62 +69718,54 @@ export namespace aiplatform_v1 { * @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$Deploymentresourcepools$Get, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel; options = {}; } @@ -69312,8 +69778,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -69324,19 +69790,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List DeploymentResourcePools in a location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -69365,21 +69829,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.list({ - * // The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. - * pageSize: 'placeholder-value', - * // A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "deploymentResourcePools": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -69394,62 +69854,54 @@ export namespace aiplatform_v1 { * @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$Deploymentresourcepools$List, + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete; options = {}; } @@ -69462,34 +69914,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update a DeploymentResourcePool. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -69518,29 +69965,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.deploymentResourcePools.patch( - * { - * // Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // Required. The list of fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "disableContainerLogging": false, - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount" - * // } + * const res = + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', * }, - * }, - * ); + * ); * console.log(res.data); * * // Example response @@ -69565,36 +69996,35 @@ export namespace aiplatform_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$Deploymentresourcepools$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + get( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + get( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69610,13 +70040,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get; options = {}; } @@ -69630,7 +70060,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -69651,7 +70081,7 @@ export namespace aiplatform_v1 { } /** - * List DeployedModels that have been deployed on this DeploymentResourcePool. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -69681,26 +70111,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels( + * await aiplatform.projects.locations.datasets.dataItems.annotations.operations.list( * { - * // Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` - * deploymentResourcePool: - * 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // The maximum number of DeployedModels to return. The service may return fewer than this value. + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation', + * // The standard list page size. * pageSize: 'placeholder-value', - * // A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "deployedModelRefs": [], - * // "deployedModels": [], * // "nextPageToken": "my_nextPageToken", - * // "totalDeployedModelCount": 0, - * // "totalEndpointCount": 0 + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -69716,62 +70147,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions ): Promise>; - queryDeployedModels( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + list( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryDeployedModels( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List, + callback: BodyResponseCallback ): void; - queryDeployedModels( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - queryDeployedModels( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$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$Deploymentresourcepools$Querydeployedmodels; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List; options = {}; } @@ -69784,100 +70215,232 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['deploymentResourcePool'], - pathParams: ['deploymentResourcePool'], + 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$Projects$Locations$Deploymentresourcepools$Create extends StandardParameters { /** - * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.datasets.dataItems.annotations.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/annotations/my-annotation/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * 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. */ - parent?: string; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Deploymentresourcepools$Delete extends StandardParameters { + + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Cancel extends StandardParameters { /** - * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Delete extends StandardParameters { /** - * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List extends StandardParameters { - /** - * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. - */ - pageSize?: number; + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Get extends StandardParameters { /** - * A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + * The name of the operation resource. */ - pageToken?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$List extends StandardParameters { /** - * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + * The standard list filter. */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch extends StandardParameters { + filter?: string; /** - * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * The name of the operation's parent resource. */ name?: string; /** - * Required. The list of fields to update. + * The standard list page size. */ - updateMask?: string; - + pageSize?: number; /** - * Request body metadata + * The standard list page token. */ - requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; - } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { + pageToken?: string; /** - * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - deploymentResourcePool?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Annotations$Operations$Wait extends StandardParameters { /** - * The maximum number of DeployedModels to return. The service may return fewer than this value. + * The name of the operation resource to wait on. */ - pageSize?: number; + name?: string; /** - * A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - pageToken?: string; + timeout?: string; } - export class Resource$Projects$Locations$Deploymentresourcepools$Operations { + export class Resource$Projects$Locations$Datasets$Dataitems$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -69914,12 +70477,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -69939,31 +70500,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -69979,13 +70540,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel; options = {}; } @@ -70050,12 +70611,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -70075,31 +70634,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70115,13 +70674,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete; options = {}; } @@ -70186,9 +70745,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.get({ + * await aiplatform.projects.locations.datasets.dataItems.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', * }); * console.log(res.data); * @@ -70215,27 +70774,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -70243,7 +70801,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70259,13 +70817,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get; options = {}; } @@ -70330,20 +70888,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -70367,29 +70923,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List, callback: BodyResponseCallback ): void; list( @@ -70397,7 +70953,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70415,13 +70971,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List; options = {}; } @@ -70491,14 +71047,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.deploymentResourcePools.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.datasets.dataItems.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/dataItems/my-dataItem/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -70524,27 +71078,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params?: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + params: Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -70552,7 +71105,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait + | Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -70568,13 +71121,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + {} as Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait; options = {}; } @@ -70609,25 +71162,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -70649,7 +71202,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Datasets$Dataitems$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -70660,35 +71213,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Endpoints { + export class Resource$Projects$Locations$Datasets$Datasetversions { context: APIRequestContext; - chat: Resource$Projects$Locations$Endpoints$Chat; - deployedModels: Resource$Projects$Locations$Endpoints$Deployedmodels; - google: Resource$Projects$Locations$Endpoints$Google; - invoke: Resource$Projects$Locations$Endpoints$Invoke; - openapi: Resource$Projects$Locations$Endpoints$Openapi; - operations: Resource$Projects$Locations$Endpoints$Operations; constructor(context: APIRequestContext) { this.context = context; - this.chat = new Resource$Projects$Locations$Endpoints$Chat(this.context); - this.deployedModels = - new Resource$Projects$Locations$Endpoints$Deployedmodels(this.context); - this.google = new Resource$Projects$Locations$Endpoints$Google( - this.context - ); - this.invoke = new Resource$Projects$Locations$Endpoints$Invoke( - this.context - ); - this.openapi = new Resource$Projects$Locations$Endpoints$Openapi( - this.context - ); - this.operations = new Resource$Projects$Locations$Endpoints$Operations( - this.context - ); } /** - * Return a list of tokens based on the input text. + * Create a version from a Dataset. * @example * ```js * // Before running the sample: @@ -70717,32 +71249,44 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "tokensInfo": [] - * // } - * } + * const res = + * await aiplatform.projects.locations.datasets.datasetVersions.create({ + * // Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', * - * main().catch(e => { - * console.error(e); - * throw e; - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); * * ``` * @@ -70751,62 +71295,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions ): Promise>; - computeTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, + create( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Endpoints$Computetokens, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + callback: BodyResponseCallback ): void; - computeTokens( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - computeTokens( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Computetokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; options = {}; } @@ -70819,7 +71358,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -70829,24 +71368,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a token counting. + * Deletes a Dataset version. * @example * ```js * // Before running the sample: @@ -70875,30 +71412,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.datasetVersions.delete({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -70914,61 +71441,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Endpoints$Counttokens, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - countTokens( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Counttokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; options = {}; } @@ -70981,34 +71504,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Endpoint. + * Gets a Dataset version. * @example * ```js * // Before running the sample: @@ -71037,50 +71555,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.create({ - * // Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. - * endpointId: 'placeholder-value', - * // Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.projects.locations.datasets.datasetVersions.get({ + * // Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -71096,57 +71590,62 @@ export namespace aiplatform_v1 { * @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$Endpoints$Create, + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Endpoints$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Create; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Create; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; options = {}; } @@ -71159,32 +71658,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an Endpoint. + * Lists DatasetVersions in a Dataset. * @example * ```js * // Before running the sample: @@ -71213,19 +71711,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.delete({ - * // Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * }); + * const res = await aiplatform.projects.locations.datasets.datasetVersions.list( + * { + * // Optional. The standard list filter. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "datasetVersions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -71241,57 +71748,62 @@ export namespace aiplatform_v1 { * @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$Endpoints$Delete, + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Endpoints$Delete, + list( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Endpoints$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; options = {}; } @@ -71304,29 +71816,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deploys a Model into this Endpoint, creating a DeployedModel within it. + * Updates a DatasetVersion. * @example * ```js * // Before running the sample: @@ -71355,28 +71872,44 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.deployModel({ - * // Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = + * await aiplatform.projects.locations.datasets.datasetVersions.patch({ + * // Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModel": {}, - * // "trafficSplit": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "modelReference": "my_modelReference", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "bigQueryDatasetName": "my_bigQueryDatasetName", + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "etag": "my_etag", * // "metadata": {}, + * // "modelReference": "my_modelReference", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -71392,57 +71925,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, options: StreamMethodOptions ): Promise>; - deployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + patch( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, options?: MethodOptions - ): Promise>; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deployModel( - params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch, + callback: BodyResponseCallback ): void; - deployModel( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - deployModel( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Deploymodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch; options = {}; } @@ -71455,32 +71993,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. + * Restores a dataset version. * @example * ```js * // Before running the sample: @@ -71501,10 +72038,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71512,25 +72046,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.directPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.datasetVersions.restore({ + * // Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/datasetVersions/my-datasetVersion', + * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [], - * // "parameters": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -71546,62 +72075,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions ): Promise>; - directPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, + restore( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + ): Promise>; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directpredict, - callback: BodyResponseCallback + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + callback: BodyResponseCallback ): void; - directPredict( - callback: BodyResponseCallback + restore( + callback: BodyResponseCallback ): void; - directPredict( + restore( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; options = {}; } @@ -71614,34 +72138,114 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( + url: (rootUrl + '/v1/{+name}:restore').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create extends StandardParameters { /** - * Perform an unary online prediction request to a gRPC model server for custom containers. + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List extends StandardParameters { + /** + * Optional. The standard list filter. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch extends StandardParameters { + /** + * Output only. Identifier. The resource name of the DatasetVersion. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Updatable fields: * `display_name` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore extends StandardParameters { + /** + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datasets$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -71662,10 +72266,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71673,25 +72274,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.directRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "input": "my_input", - * // "methodName": "my_methodName" - * // } - * }, + * const res = await aiplatform.projects.locations.datasets.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "output": "my_output" - * // } + * // {} * } * * main().catch(e => { @@ -71706,62 +72296,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions ): Promise>; - directRawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - directRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directRawPredict( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + callback: BodyResponseCallback ): void; - directRawPredict( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Directrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; options = {}; } @@ -71774,34 +72356,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -71822,10 +72399,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71833,29 +72407,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.explain({ - * // Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "explanationSpecOverride": {}, - * // "instances": [], - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.projects.locations.datasets.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "deployedModelId": "my_deployedModelId", - * // "explanations": [], - * // "predictions": [] - * // } + * // {} * } * * main().catch(e => { @@ -71870,61 +72429,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions ): Promise>; - explain( - params?: Params$Resource$Projects$Locations$Endpoints$Explain, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - explain( - params: Params$Resource$Projects$Locations$Endpoints$Explain, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - explain( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + callback: BodyResponseCallback ): void; - explain( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Explain - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Explain; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; + params = + {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; options = {}; } @@ -71937,34 +72489,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:explain').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetch an asynchronous online prediction operation. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -71985,10 +72532,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -71996,20 +72540,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.endpoints.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.datasets.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -72034,36 +72568,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + get( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, options?: MethodOptions ): Promise>; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, callback: BodyResponseCallback ): void; - fetchPredictOperation( + get( callback: BodyResponseCallback ): void; - fetchPredictOperation( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation + | Params$Resource$Projects$Locations$Datasets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -72079,13 +72612,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; options = {}; } @@ -72098,18 +72631,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -72123,7 +72653,7 @@ export namespace aiplatform_v1 { } /** - * Generate content with multimodal inputs. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -72144,10 +72674,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72155,38 +72682,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.projects.locations.datasets.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} - * // } - * } + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] + * // } + * } * * main().catch(e => { * console.error(e); @@ -72200,62 +72716,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + list( + params?: Params$Resource$Projects$Locations$Datasets$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Operations$List, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - generateContent( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Generatecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Operations$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$Endpoints$Generatecontent; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Generatecontent; + {} as Params$Resource$Projects$Locations$Datasets$Operations$List; options = {}; } @@ -72268,34 +72784,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets an Endpoint. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -72324,36 +72840,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.get({ - * // Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = await aiplatform.projects.locations.datasets.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -72369,57 +72870,57 @@ export namespace aiplatform_v1 { * @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$Endpoints$Get, + wait( + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Endpoints$Get, + wait( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, + wait( + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Endpoints$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Datasets$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Get; + params = + {} as Params$Resource$Projects$Locations$Datasets$Operations$Wait; options = {}; } @@ -72432,8 +72933,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -72444,19 +72945,80 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Operations$Cancel extends StandardParameters { /** - * Lists Endpoints in a Location. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Datasets$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Datasets$Savedqueries { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datasets$Savedqueries$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datasets$Savedqueries$Operations( + this.context + ); + } + + /** + * Deletes a SavedQuery. * @example * ```js * // Before running the sample: @@ -72485,28 +73047,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - * filter: 'placeholder-value', - * // Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. - * gdcZone: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.datasets.savedQueries.delete({ + * // Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', * }); * console.log(res.data); * * // Example response * // { - * // "endpoints": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -72522,61 +73075,57 @@ export namespace aiplatform_v1 { * @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$Endpoints$List, + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Endpoints$List, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$List; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$List; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete; options = {}; } @@ -72589,34 +73138,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/endpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only). + * Lists SavedQueries in a Dataset. * @example * ```js * // Before running the sample: @@ -72645,31 +73189,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.mutateDeployedModel( - * { - * // Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModel": {}, - * // "updateMask": "my_updateMask" - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.datasets.savedQueries.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + * parent: 'projects/my-project/locations/my-location/datasets/my-dataset', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "savedQueries": [] * // } * } * @@ -72685,58 +73224,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: StreamMethodOptions ): Promise>; - mutateDeployedModel( - params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options?: MethodOptions - ): Promise>; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedModel( - params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$List, + callback: BodyResponseCallback ): void; - mutateDeployedModel( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - mutateDeployedModel( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$List; options = {}; } @@ -72749,32 +73292,74 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( + url: (rootUrl + '/v1/{+parent}/savedQueries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Delete extends StandardParameters { /** - * Updates an Endpoint. + * Required. The resource name of the SavedQuery to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/savedQueries/{saved_query\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list SavedQueries from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Datasets$Savedqueries$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -72803,68 +73388,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.patch({ - * // Identifier. The resource name of the Endpoint. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.savedQueries.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "clientConnectionConfig": {}, - * // "createTime": "my_createTime", - * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", - * // "dedicatedEndpointEnabled": false, - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "gdcConfig": {}, - * // "genAiAdvancedFeaturesConfig": {}, - * // "labels": {}, - * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", - * // "name": "my_name", - * // "network": "my_network", - * // "predictRequestResponseLoggingConfig": {}, - * // "privateServiceConnectConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "trafficSplit": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -72879,57 +73413,54 @@ export namespace aiplatform_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$Endpoints$Patch, + cancel( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Endpoints$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Endpoints$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Patch; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel; options = {}; } @@ -72942,8 +73473,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -72954,18 +73485,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -72986,10 +73516,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -72997,31 +73524,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.savedQueries.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "deployedModelId": "my_deployedModelId", - * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] - * // } + * // {} * } * * main().catch(e => { @@ -73036,61 +73549,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Projects$Locations$Endpoints$Predict, + delete( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - predict( - params: Params$Resource$Projects$Locations$Endpoints$Predict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete, + callback: BodyResponseCallback ): void; - predict( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Predict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Predict; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete; options = {}; } @@ -73103,33 +73609,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -73150,10 +73652,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -73161,20 +73660,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.savedQueries.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -73199,36 +73689,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + get( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options?: MethodOptions ): Promise>; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get, callback: BodyResponseCallback ): void; - predictLongRunning( + get( callback: BodyResponseCallback ): void; - predictLongRunning( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Predictlongrunning + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -73244,13 +73733,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get; options = {}; } @@ -73263,18 +73752,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -73288,7 +73774,7 @@ export namespace aiplatform_v1 { } /** - * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -73309,10 +73795,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -73320,25 +73803,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.rawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.datasets.savedQueries.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -73354,53 +73838,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions ): Promise>; - rawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + list( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options?: MethodOptions - ): Promise>; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Rawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + params = + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$List; options = {}; } @@ -73413,32 +73906,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -73459,10 +73954,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -73471,26 +73963,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.endpoints.serverStreamingPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, + * await aiplatform.projects.locations.datasets.savedQueries.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/datasets/my-dataset/savedQueries/my-savedQuerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [], - * // "parameters": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -73506,62 +73993,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + wait( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions ): Promise>; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + wait( + params?: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + wait( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - serverStreamingPredict( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + {}) as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + {} as Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait; options = {}; } @@ -73574,83 +74056,131 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Cancel extends StandardParameters { /** - * Generate content with multimodal inputs with streaming support. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', - * ], - * }); - * - * // 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 aiplatform.projects.locations.endpoints.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Datasets$Savedqueries$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Deploymentresourcepools { + context: APIRequestContext; + operations: Resource$Projects$Locations$Deploymentresourcepools$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Deploymentresourcepools$Operations( + this.context + ); + } + + /** + * Create a DeploymentResourcePool. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.create({ + * // Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deploymentResourcePool": {}, + * // "deploymentResourcePoolId": "my_deploymentResourcePoolId" * // } * }, * }); @@ -73658,12 +74188,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -73679,62 +74208,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + create( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + create( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + create( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Create, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - streamGenerateContent( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Create; options = {}; } @@ -73747,7 +74271,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( /([^:]\/)\/+/g, '$1' ), @@ -73757,24 +74281,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a streaming online prediction with an arbitrary HTTP payload. + * Delete a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -73795,10 +74317,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -73806,25 +74325,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.deploymentResourcePools.delete({ + * // Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -73840,56 +74354,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions ): Promise>; - streamRawPredict( - params?: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + delete( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options?: MethodOptions - ): Promise>; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Delete, + callback: BodyResponseCallback ): void; - streamRawPredict( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - streamRawPredict( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Streamrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Delete; options = {}; } @@ -73902,32 +74417,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. + * Get a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -73956,28 +74468,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.undeployModel({ - * // Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "trafficSplit": {} - * // } - * }, + * const res = await aiplatform.projects.locations.deploymentResourcePools.get({ + * // Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "encryptionSpec": {}, * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount" * // } * } * @@ -73993,58 +74499,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions ): Promise>; - undeployModel( - params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + get( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options?: MethodOptions - ): Promise>; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undeployModel( - params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Get, + callback: BodyResponseCallback ): void; - undeployModel( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - undeployModel( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Undeploymodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Get; options = {}; } @@ -74057,32 +74567,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates an Endpoint with a long running operation. + * List DeploymentResourcePools in a location. * @example * ```js * // Before running the sample: @@ -74111,27 +74620,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.update({ - * // Identifier. The resource name of the Endpoint. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "endpoint": {} - * // } - * }, + * const res = await aiplatform.projects.locations.deploymentResourcePools.list({ + * // The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "deploymentResourcePools": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -74147,57 +74649,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions ): Promise>; - update( - params?: Params$Resource$Projects$Locations$Endpoints$Update, + list( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - update( - params: Params$Resource$Projects$Locations$Endpoints$Update, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$List, + callback: BodyResponseCallback ): void; - update( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - update( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Update - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Update; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpoints$Update; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$List; options = {}; } @@ -74210,296 +74717,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:update').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/deploymentResourcePools').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Computetokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Counttokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters { - /** - * Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. - */ - endpointId?: string; - /** - * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; - } - export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters { - /** - * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Explain extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Generatecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters { - /** - * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - */ - filter?: string; - /** - * Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. - */ - gdcZone?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel extends StandardParameters { - /** - * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters { - /** - * Identifier. The resource name of the Endpoint. - */ - name?: string; - /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; - } - export interface Params$Resource$Projects$Locations$Endpoints$Predict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Predictlongrunning extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel extends StandardParameters { - /** - * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; - } - export interface Params$Resource$Projects$Locations$Endpoints$Update extends StandardParameters { - /** - * Identifier. The resource name of the Endpoint. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest; - } - - export class Resource$Projects$Locations$Endpoints$Chat { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Exposes an OpenAI-compatible endpoint for chat completions. + * Update a DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -74520,10 +74765,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -74531,27 +74773,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.chat.completions({ - * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * const res = await aiplatform.projects.locations.deploymentResourcePools.patch( + * { + * // Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // Required. The list of fields to update. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "disableContainerLogging": false, + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount" + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -74567,54 +74820,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options: StreamMethodOptions ): Promise>; - completions( - params?: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options?: MethodOptions - ): Promise>; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback ): void; - completions(callback: BodyResponseCallback): void; - completions( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Chat$Completions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; options = {}; } @@ -74627,63 +74883,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Chat$Completions extends StandardParameters { - /** - * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - - export class Resource$Projects$Locations$Endpoints$Deployedmodels { - context: APIRequestContext; - invoke: Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke; - constructor(context: APIRequestContext) { - this.context = context; - this.invoke = - new Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke( - this.context - ); - } - } - - export class Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * List DeployedModels that have been deployed on this DeploymentResourcePool. * @example * ```js * // Before running the sample: @@ -74704,10 +74926,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -74716,31 +74935,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * invokeId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "httpBody": {} - * // } + * await aiplatform.projects.locations.deploymentResourcePools.queryDeployedModels( + * { + * // Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + * deploymentResourcePool: + * 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // The maximum number of DeployedModels to return. The service may return fewer than this value. + * pageSize: 'placeholder-value', + * // A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + * pageToken: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "deployedModelRefs": [], + * // "deployedModels": [], + * // "nextPageToken": "my_nextPageToken", + * // "totalDeployedModelCount": 0, + * // "totalEndpointCount": 0 * // } * } * @@ -74756,54 +74970,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions ): Promise>; - invoke( - params?: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + queryDeployedModels( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options?: MethodOptions - ): Promise>; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + ): Promise< + GaxiosResponseWithHTTP2 + >; + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, - callback: BodyResponseCallback + queryDeployedModels( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels, + callback: BodyResponseCallback ): void; - invoke(callback: BodyResponseCallback): void; - invoke( + queryDeployedModels( + callback: BodyResponseCallback + ): void; + queryDeployedModels( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke - | BodyResponseCallback + | Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels; options = {}; } @@ -74817,69 +75039,16389 @@ export namespace aiplatform_v1 { options: Object.assign( { url: ( - rootUrl + - '/v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}' + rootUrl + '/v1/{+deploymentResourcePool}:queryDeployedModels' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint', 'deployedModelId', 'invokeId'], - pathParams: ['deployedModelId', 'endpoint', 'invokeId'], + requiredParams: ['deploymentResourcePool'], + pathParams: ['deploymentResourcePool'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke extends StandardParameters { + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Create extends StandardParameters { /** - * ID of the DeployedModel that serves the invoke request. + * Required. The parent location resource where this DeploymentResourcePool will be created. Format: `projects/{project\}/locations/{location\}` */ - deployedModelId?: string; + parent?: string; + /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * Request body metadata */ - endpoint?: string; + requestBody?: Schema$GoogleCloudAiplatformV1CreateDeploymentResourcePoolRequest; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Delete extends StandardParameters { /** - * + * Required. The name of the DeploymentResourcePool to delete. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ - invokeId?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Get extends StandardParameters { /** - * Request body metadata + * Required. The name of the DeploymentResourcePool to retrieve. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; - } - - export class Resource$Projects$Locations$Endpoints$Google { - context: APIRequestContext; - science: Resource$Projects$Locations$Endpoints$Google$Science; - constructor(context: APIRequestContext) { - this.context = context; - this.science = new Resource$Projects$Locations$Endpoints$Google$Science( - this.context - ); - } + name?: string; } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$List extends StandardParameters { + /** + * The maximum number of DeploymentResourcePools to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListDeploymentResourcePools` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentResourcePools` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent Location which owns this collection of DeploymentResourcePools. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { + /** + * Required. The name of the target DeploymentResourcePool to query. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + deploymentResourcePool?: string; + /** + * The maximum number of DeployedModels to return. The service may return fewer than this value. + */ + pageSize?: number; + /** + * A page token, received from a previous `QueryDeployedModels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `QueryDeployedModels` must match the call that provided the page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Deploymentresourcepools$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').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); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example 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$Deploymentresourcepools$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * }); + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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$Deploymentresourcepools$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.deploymentResourcePools.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/deploymentResourcePools/my-deploymentResourcePool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * 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. + */ + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Deploymentresourcepools$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Endpoints { + context: APIRequestContext; + chat: Resource$Projects$Locations$Endpoints$Chat; + deployedModels: Resource$Projects$Locations$Endpoints$Deployedmodels; + google: Resource$Projects$Locations$Endpoints$Google; + invoke: Resource$Projects$Locations$Endpoints$Invoke; + openapi: Resource$Projects$Locations$Endpoints$Openapi; + operations: Resource$Projects$Locations$Endpoints$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.chat = new Resource$Projects$Locations$Endpoints$Chat(this.context); + this.deployedModels = + new Resource$Projects$Locations$Endpoints$Deployedmodels(this.context); + this.google = new Resource$Projects$Locations$Endpoints$Google( + this.context + ); + this.invoke = new Resource$Projects$Locations$Endpoints$Invoke( + this.context + ); + this.openapi = new Resource$Projects$Locations$Endpoints$Openapi( + this.context + ); + this.operations = new Resource$Projects$Locations$Endpoints$Operations( + this.context + ); + } + + /** + * Return a list of tokens based on the input text. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "tokensInfo": [] + * // } + * } + * + * 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. + */ + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + options: StreamMethodOptions + ): Promise>; + computeTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Computetokens, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + computeTokens( + params: Params$Resource$Projects$Locations$Endpoints$Computetokens, + callback: BodyResponseCallback + ): void; + computeTokens( + callback: BodyResponseCallback + ): void; + computeTokens( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Computetokens + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Computetokens; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Computetokens; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform a token counting. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 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. + */ + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + options: StreamMethodOptions + ): Promise>; + countTokens( + params?: Params$Resource$Projects$Locations$Endpoints$Counttokens, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Projects$Locations$Endpoints$Counttokens, + callback: BodyResponseCallback + ): void; + countTokens( + callback: BodyResponseCallback + ): void; + countTokens( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Counttokens + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Counttokens; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Counttokens; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an Endpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.create({ + * // Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + * endpointId: 'placeholder-value', + * // Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Endpoints$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Endpoints$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/endpoints').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 Endpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.delete({ + * // Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * }); + * 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$Endpoints$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Endpoints$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Deploys a Model into this Endpoint, creating a DeployedModel within it. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.deployModel({ + * // Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModel": {}, + * // "trafficSplit": {} + * // } + * }, + * }); + * 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. + */ + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + options: StreamMethodOptions + ): Promise>; + deployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + options?: MethodOptions + ): Promise>; + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deployModel( + params: Params$Resource$Projects$Locations$Endpoints$Deploymodel, + callback: BodyResponseCallback + ): void; + deployModel( + callback: BodyResponseCallback + ): void; + deployModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Deploymodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Deploymodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:deployModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Perform an unary online prediction request to a gRPC model server for Vertex first-party products and frameworks. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.directPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [], + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "outputs": [], + * // "parameters": {} + * // } + * } + * + * 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. + */ + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + options: StreamMethodOptions + ): Promise>; + directPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directpredict, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directpredict, + callback: BodyResponseCallback + ): void; + directPredict( + callback: BodyResponseCallback + ): void; + directPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Directpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Directpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Directpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:directPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform an unary online prediction request to a gRPC model server for custom containers. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.directRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "input": "my_input", + * // "methodName": "my_methodName" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "output": "my_output" + * // } + * } + * + * 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. + */ + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + options: StreamMethodOptions + ): Promise>; + directRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Directrawpredict, + callback: BodyResponseCallback + ): void; + directRawPredict( + callback: BodyResponseCallback + ): void; + directRawPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Directrawpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Directrawpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:directRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform an online explanation. If deployed_model_id is specified, the corresponding DeployModel must have explanation_spec populated. If deployed_model_id is not specified, all DeployedModels must have explanation_spec populated. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.explain({ + * // Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "explanationSpecOverride": {}, + * // "instances": [], + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "deployedModelId": "my_deployedModelId", + * // "explanations": [], + * // "predictions": [] + * // } + * } + * + * 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. + */ + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + options: StreamMethodOptions + ): Promise>; + explain( + params?: Params$Resource$Projects$Locations$Endpoints$Explain, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + explain( + params: Params$Resource$Projects$Locations$Endpoints$Explain, + callback: BodyResponseCallback + ): void; + explain( + callback: BodyResponseCallback + ): void; + explain( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Explain + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Explain; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Explain; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:explain').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetch an asynchronous online prediction operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, + * }); + * 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. + */ + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + options: StreamMethodOptions + ): Promise>; + fetchPredictOperation( + params?: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + options?: MethodOptions + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generate content with multimodal inputs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * 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. + */ + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + options: StreamMethodOptions + ): Promise>; + generateContent( + params?: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateContent( + params: Params$Resource$Projects$Locations$Endpoints$Generatecontent, + callback: BodyResponseCallback + ): void; + generateContent( + callback: BodyResponseCallback + ): void; + generateContent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Generatecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Generatecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Generatecontent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['model'], + pathParams: ['model'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an Endpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.get({ + * // Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "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$Endpoints$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Endpoints$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 Endpoints in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * filter: 'placeholder-value', + * // Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. + * gdcZone: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "endpoints": [], + * // "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$Endpoints$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Endpoints$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Endpoints$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/endpoints').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 existing deployed model. Updatable fields include `min_replica_count`, `max_replica_count`, `required_replica_count`, `autoscaling_metric_specs`, `disable_container_logging` (v1 only), and `enable_container_logging` (v1beta1 only). + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.mutateDeployedModel( + * { + * // Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModel": {}, + * // "updateMask": "my_updateMask" + * // } + * }, + * }, + * ); + * 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. + */ + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + options: StreamMethodOptions + ): Promise>; + mutateDeployedModel( + params?: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + options?: MethodOptions + ): Promise>; + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + mutateDeployedModel( + params: Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel, + callback: BodyResponseCallback + ): void; + mutateDeployedModel( + callback: BodyResponseCallback + ): void; + mutateDeployedModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:mutateDeployedModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an Endpoint. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.patch({ + * // Identifier. The resource name of the Endpoint. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "clientConnectionConfig": {}, + * // "createTime": "my_createTime", + * // "dedicatedEndpointDns": "my_dedicatedEndpointDns", + * // "dedicatedEndpointEnabled": false, + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "gdcConfig": {}, + * // "genAiAdvancedFeaturesConfig": {}, + * // "labels": {}, + * // "modelDeploymentMonitoringJob": "my_modelDeploymentMonitoringJob", + * // "name": "my_name", + * // "network": "my_network", + * // "predictRequestResponseLoggingConfig": {}, + * // "privateServiceConnectConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "trafficSplit": {}, + * // "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$Endpoints$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Endpoints$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Endpoints$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] + * // } + * } + * + * 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. + */ + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + options: StreamMethodOptions + ): Promise>; + predict( + params?: Params$Resource$Projects$Locations$Endpoints$Predict, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predict( + params: Params$Resource$Projects$Locations$Endpoints$Predict, + callback: BodyResponseCallback + ): void; + predict( + callback: BodyResponseCallback + ): void; + predict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Predict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Predict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Predict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, + * }); + * 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. + */ + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + options: StreamMethodOptions + ): Promise>; + predictLongRunning( + params?: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + options?: MethodOptions + ): Promise>; + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + predictLongRunning( + params: Params$Resource$Projects$Locations$Endpoints$Predictlongrunning, + callback: BodyResponseCallback + ): void; + predictLongRunning( + callback: BodyResponseCallback + ): void; + predictLongRunning( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Predictlongrunning + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Predictlongrunning; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.rawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options: StreamMethodOptions + ): Promise>; + rawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options?: MethodOptions + ): Promise>; + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Rawpredict, + callback: BodyResponseCallback + ): void; + rawPredict(callback: BodyResponseCallback): void; + rawPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Rawpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Rawpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.serverStreamingPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [], + * // "parameters": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "outputs": [], + * // "parameters": {} + * // } + * } + * + * 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. + */ + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + options: StreamMethodOptions + ): Promise>; + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict, + callback: BodyResponseCallback + ): void; + serverStreamingPredict( + callback: BodyResponseCallback + ): void; + serverStreamingPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Generate content with multimodal inputs with streaming support. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * 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. + */ + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: StreamMethodOptions + ): Promise>; + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + callback: BodyResponseCallback + ): void; + streamGenerateContent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['model'], + pathParams: ['model'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Perform a streaming online prediction with an arbitrary HTTP payload. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.streamRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: StreamMethodOptions + ): Promise>; + streamRawPredict( + params?: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options?: MethodOptions + ): Promise>; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamRawPredict( + params: Params$Resource$Projects$Locations$Endpoints$Streamrawpredict, + callback: BodyResponseCallback + ): void; + streamRawPredict( + callback: BodyResponseCallback + ): void; + streamRawPredict( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Streamrawpredict + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Streamrawpredict; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Undeploys a Model from an Endpoint, removing a DeployedModel from it, and freeing all resources it's using. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.undeployModel({ + * // Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "trafficSplit": {} + * // } + * }, + * }); + * 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. + */ + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: StreamMethodOptions + ): Promise>; + undeployModel( + params?: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options?: MethodOptions + ): Promise>; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undeployModel( + params: Params$Resource$Projects$Locations$Endpoints$Undeploymodel, + callback: BodyResponseCallback + ): void; + undeployModel( + callback: BodyResponseCallback + ): void; + undeployModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Undeploymodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Undeploymodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:undeployModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an Endpoint with a long running operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.update({ + * // Identifier. The resource name of the Endpoint. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "endpoint": {} + * // } + * }, + * }); + * 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. + */ + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: StreamMethodOptions + ): Promise>; + update( + params?: Params$Resource$Projects$Locations$Endpoints$Update, + options?: MethodOptions + ): Promise>; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Endpoints$Update, + callback: BodyResponseCallback + ): void; + update( + callback: BodyResponseCallback + ): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Endpoints$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:update').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$Endpoints$Computetokens extends StandardParameters { + /** + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Counttokens extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Create extends StandardParameters { + /** + * Immutable. The ID to use for endpoint, which will become the final component of the endpoint resource name. If not provided, Vertex AI will generate a value for this ID. If the first character is a letter, this value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The last character must be a letter or number. If the first character is a number, this value may be up to 9 characters, and valid characters are `[0-9]` with no leading zeros. When using HTTP/JSON, this field is populated based on a query string argument, such as `?endpoint_id=12345`. This is the fallback for fields that are not included in either the URI or the body. + */ + endpointId?: string; + /** + * Required. The resource name of the Location to create the Endpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Delete extends StandardParameters { + /** + * Required. The name of the Endpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Deploymodel extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to deploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Directrawpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DirectRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Explain extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the explanation. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExplainRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Fetchpredictoperation extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Generatecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Get extends StandardParameters { + /** + * Required. The name of the Endpoint resource. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `endpoint` supports `=` and `!=`. `endpoint` represents the Endpoint ID, i.e. the last segment of the Endpoint's resource name. * `display_name` supports `=` and `!=`. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:*` or `labels:key` - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports `=`. Some examples: * `endpoint=1` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + */ + filter?: string; + /** + * Optional. Configures the Google Distributed Cloud (GDC) environment for online prediction. Only set this field when the Endpoint is to be deployed in a GDC environment. + */ + gdcZone?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListEndpointsResponse.next_page_token of the previous EndpointService.ListEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Endpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Mutatedeployedmodel extends StandardParameters { + /** + * Required. The name of the Endpoint resource into which to mutate a DeployedModel. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MutateDeployedModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Patch extends StandardParameters { + /** + * Identifier. The resource name of the Endpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Endpoint; + } + export interface Params$Resource$Projects$Locations$Endpoints$Predict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Predictlongrunning extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Rawpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Serverstreamingpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamgeneratecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Streamrawpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Undeploymodel extends StandardParameters { + /** + * Required. The name of the Endpoint resource from which to undeploy a Model. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployModelRequest; + } + export interface Params$Resource$Projects$Locations$Endpoints$Update extends StandardParameters { + /** + * Identifier. The resource name of the Endpoint. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpdateEndpointLongRunningRequest; + } + + export class Resource$Projects$Locations$Endpoints$Chat { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Exposes an OpenAI-compatible endpoint for chat completions. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.chat.completions({ + * // Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: StreamMethodOptions + ): Promise>; + completions( + params?: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options?: MethodOptions + ): Promise>; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Chat$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Chat$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Chat$Completions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/chat/completions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Chat$Completions extends StandardParameters { + /** + * Required. The name of the endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$Deployedmodels { + context: APIRequestContext; + invoke: Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke; + constructor(context: APIRequestContext) { + this.context = context; + this.invoke = + new Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke( + this.context + ); + } + } + + export class Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.deployedModels.invoke.invoke({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions + ): Promise>; + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options?: MethodOptions + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke, + callback: BodyResponseCallback + ): void; + invoke(callback: BodyResponseCallback): void; + invoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+endpoint}/deployedModels/{deployedModelId}/invoke/{+invokeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint', 'deployedModelId', 'invokeId'], + pathParams: ['deployedModelId', 'endpoint', 'invokeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Deployedmodels$Invoke$Invoke extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Google { + context: APIRequestContext; + science: Resource$Projects$Locations$Endpoints$Google$Science; + constructor(context: APIRequestContext) { + this.context = context; + this.science = new Resource$Projects$Locations$Endpoints$Google$Science( + this.context + ); + } + } + + export class Resource$Projects$Locations$Endpoints$Google$Science { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.google.science.inference({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/google', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + inference( + params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + options: StreamMethodOptions + ): Promise>; + inference( + params?: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + options?: MethodOptions + ): Promise>; + inference( + params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + inference( + params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + inference( + params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + callback: BodyResponseCallback + ): void; + inference(callback: BodyResponseCallback): void; + inference( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/science/inference').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.invoke.invoke({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: StreamMethodOptions + ): Promise>; + invoke( + params?: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options?: MethodOptions + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + invoke( + params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + callback: BodyResponseCallback + ): void; + invoke(callback: BodyResponseCallback): void; + invoke( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint', 'invokeId'], + pathParams: ['endpoint', 'invokeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Endpoints$Openapi { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.openapi.completions( + * { + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: StreamMethodOptions + ): Promise>; + completions( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options?: MethodOptions + ): Promise>; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completions( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + callback: BodyResponseCallback + ): void; + completions(callback: BodyResponseCallback): void; + completions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Openapi$Completions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/completions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.openapi.embeddings({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: StreamMethodOptions + ): Promise>; + embeddings( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options?: MethodOptions + ): Promise>; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + embeddings( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + callback: BodyResponseCallback + ): void; + embeddings(callback: BodyResponseCallback): void; + embeddings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/embeddings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.projects.locations.endpoints.openapi.responses({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * } + * + * 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. + */ + responses( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + options: StreamMethodOptions + ): Promise>; + responses( + params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + options?: MethodOptions + ): Promise>; + responses( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + responses( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + responses( + params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + callback: BodyResponseCallback + ): void; + responses(callback: BodyResponseCallback): void; + responses( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Openapi$Responses + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Responses; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Responses; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}/responses').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Completions extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Responses extends StandardParameters { + /** + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Endpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').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); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example 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$Endpoints$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * }); + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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$Endpoints$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.endpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * 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. + */ + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Endpoints$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpoints$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Evaluationitems { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationItems.create({ + * // Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * 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$Evaluationitems$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationitems$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationitems$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').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 Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationItems.delete({ + * // Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * 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$Evaluationitems$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Evaluation Item. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationItems.get({ + * // Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationItemType": "my_evaluationItemType", + * // "evaluationRequest": {}, + * // "evaluationResponse": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name" + * // } + * } + * + * 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$Evaluationitems$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationitems$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationitems$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 Evaluation Items. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationItems.list({ + * // Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Items to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationItems": [], + * // "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$Evaluationitems$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationitems$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationitems$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationItems').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationitems$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationItem; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Delete extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$Get extends StandardParameters { + /** + * Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationitems$List extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Items to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationmetrics { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an EvaluationMetric. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationMetrics.create({ + * // Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. + * evaluationMetricId: 'placeholder-value', + * // Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metric": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metric": {}, + * // "name": "my_name", + * // "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$Evaluationmetrics$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationmetrics$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationmetrics$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationmetrics$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationmetrics$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationMetrics').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 EvaluationMetric. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationMetrics.delete({ + * // Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationMetrics/{evaluation_metric\}` + * name: 'projects/my-project/locations/my-location/evaluationMetrics/my-evaluationMetric', + * }); + * 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$Evaluationmetrics$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationmetrics$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationmetrics$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationmetrics$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationmetrics$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 EvaluationMetric. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationMetrics.get({ + * // Required. The name of the EvaluationMetric resource. Format: `projects/{project\}/locations/{location\}/evaluationMetrics/{evaluation_metric\}` + * name: 'projects/my-project/locations/my-location/evaluationMetrics/my-evaluationMetric', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "gcsUri": "my_gcsUri", + * // "labels": {}, + * // "metric": {}, + * // "name": "my_name", + * // "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$Evaluationmetrics$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationmetrics$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationmetrics$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationmetrics$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationmetrics$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationmetrics$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 EvaluationMetrics. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationMetrics.list({ + * // Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of EvaluationMetrics to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationMetrics": [], + * // "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$Evaluationmetrics$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationmetrics$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationmetrics$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationmetrics$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationmetrics$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationmetrics$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationmetrics$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Evaluationmetrics$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationMetrics').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationmetrics$Create extends StandardParameters { + /** + * Optional. The ID to use for the EvaluationMetric, which will become the final component of the EvaluationMetric's resource name. This value should be 1-63 characters, and valid characters are /a-z-/. The first character must be a lowercase letter, and the last character must be a lowercase letter or number. + */ + evaluationMetricId?: string; + /** + * Required. The resource name of the Location to create the EvaluationMetric in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationMetric; + } + export interface Params$Resource$Projects$Locations$Evaluationmetrics$Delete extends StandardParameters { + /** + * Required. The name of the EvaluationMetric resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationMetrics/{evaluation_metric\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationmetrics$Get extends StandardParameters { + /** + * Required. The name of the EvaluationMetric resource. Format: `projects/{project\}/locations/{location\}/evaluationMetrics/{evaluation_metric\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationmetrics$List extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationMetrics to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of EvaluationMetrics to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationMetrics` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the EvaluationMetrics. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationruns { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationRuns.cancel({ + * // Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').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); + } + } + + /** + * Creates an Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationRuns.create({ + * // Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "state": "my_state" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "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. + */ + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationruns$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationruns$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').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 Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationRuns.delete({ + * // Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * 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$Evaluationruns$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Evaluation Run. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationRuns.get({ + * // Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "completionTime": "my_completionTime", + * // "createTime": "my_createTime", + * // "dataSource": {}, + * // "displayName": "my_displayName", + * // "error": {}, + * // "evaluationConfig": {}, + * // "evaluationResults": {}, + * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", + * // "inferenceConfigs": {}, + * // "labels": {}, + * // "metadata": {}, + * // "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. + */ + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationruns$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationruns$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 Evaluation Runs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationRuns.list({ + * // Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Runs to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationRuns": [], + * // "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$Evaluationruns$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationruns$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationruns$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationruns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationruns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationruns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationRuns').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationruns$Cancel extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationRun; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Delete extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$Get extends StandardParameters { + /** + * Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationruns$List extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Runs to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Evaluationsets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.create({ + * // Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentConfigs": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "agentConfigs": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "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$Evaluationsets$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Evaluationsets$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluationsets$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets').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 Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.delete({ + * // Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * 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$Evaluationsets$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.get({ + * // Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "agentConfigs": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "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$Evaluationsets$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Evaluationsets$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Evaluationsets$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * Imports an Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.import({ + * // Required. Parent resource name. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentEngineSource": {}, + * // "bigquerySource": {}, + * // "cloudTraceSource": {}, + * // "evaluationSet": {}, + * // "gcsDestination": {}, + * // "gcsSource": {}, + * // "inlineSource": {} + * // } + * }, + * }); + * 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. + */ + import( + params: Params$Resource$Projects$Locations$Evaluationsets$Import, + options: StreamMethodOptions + ): Promise>; + import( + params?: Params$Resource$Projects$Locations$Evaluationsets$Import, + options?: MethodOptions + ): Promise>; + import( + params: Params$Resource$Projects$Locations$Evaluationsets$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Evaluationsets$Import, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Evaluationsets$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets:import').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); + } + } + + /** + * Lists Evaluation Sets. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.list({ + * // Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of Evaluation Sets to return. + * pageSize: 'placeholder-value', + * // Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "evaluationSets": [], + * // "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$Evaluationsets$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Evaluationsets$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Evaluationsets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/evaluationSets').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 Evaluation Set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.patch({ + * // Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * // Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentConfigs": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "agentConfigs": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "evaluationItems": [], + * // "metadata": {}, + * // "name": "my_name", + * // "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$Evaluationsets$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluationsets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluationsets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluationsets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Evaluationsets$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Delete extends StandardParameters { + /** + * Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Get extends StandardParameters { + /** + * Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Import extends StandardParameters { + /** + * Required. Parent resource name. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportEvaluationSetRequest; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$List extends StandardParameters { + /** + * Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The maximum number of Evaluation Sets to return. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluationsets$Patch extends StandardParameters { + /** + * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + */ + name?: string; + /** + * Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + } + + export class Resource$Projects$Locations$Featuregroups { + context: APIRequestContext; + features: Resource$Projects$Locations$Featuregroups$Features; + operations: Resource$Projects$Locations$Featuregroups$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.features = new Resource$Projects$Locations$Featuregroups$Features( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featuregroups$Operations(this.context); + } + + /** + * Creates a new FeatureGroup in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.create({ + * // Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featureGroupId: 'placeholder-value', + * // Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureGroups').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 a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.delete({ + * // If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + * force: 'placeholder-value', + * // Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * 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$Featuregroups$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 details of a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.get({ + * // Required. The name of the FeatureGroup resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "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$Featuregroups$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.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/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "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$Locations$Featuregroups$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').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); + } + } + + /** + * Lists FeatureGroups in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.list({ + * // Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureGroups": [], + * // "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$Featuregroups$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureGroups').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 the parameters of a single FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.patch({ + * // Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * // Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuery": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.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/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "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$Locations$Featuregroups$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').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$Locations$Featuregroups$Create extends StandardParameters { + /** + * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureGroupId?: string; + /** + * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Delete extends StandardParameters { + /** + * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + */ + force?: boolean; + /** + * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Get extends StandardParameters { + /** + * Required. The name of the FeatureGroup resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$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$Locations$Featuregroups$List extends StandardParameters { + /** + * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Patch extends StandardParameters { + /** + * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$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$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Features { + context: APIRequestContext; + operations: Resource$Projects$Locations$Featuregroups$Features$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Featuregroups$Features$Operations( + this.context + ); + } + + /** + * Creates a batch of Features in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.batchCreate({ + * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, + * }); + * 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. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: StreamMethodOptions + ): Promise>; + batchCreate( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options?: MethodOptions + ): Promise>; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features:batchCreate').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); + } + } + + /** + * Creates a new Feature in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.create( + * { + * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * featureId: 'placeholder-value', + * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').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 a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.delete( + * { + * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * }, + * ); + * 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$Featuregroups$Features$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 details of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.get({ + * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * } + * + * 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$Featuregroups$Features$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 Features in a given FeatureGroup. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.list({ + * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + * latestStatsCount: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "features": [], + * // "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$Featuregroups$Features$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/features').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 the parameters of a single Feature. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.patch({ + * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', + * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate extends StandardParameters { + /** + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get extends StandardParameters { + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$List extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + + export class Resource$Projects$Locations$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * }, + * ); + * console.log(res.data); + * + * // Example 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$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * }); + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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. + */ + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.features.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * 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. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Featuregroups$Features$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example 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$Featuregroups$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * }); + * 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. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.operations.listWait({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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. + */ + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: StreamMethodOptions + ): Promise>; + listWait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listWait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + callback: BodyResponseCallback + ): void; + listWait( + callback: BodyResponseCallback + ): void; + listWait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureGroups.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); + * 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. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Featuregroups$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores { + context: APIRequestContext; + featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; + operations: Resource$Projects$Locations$Featureonlinestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViews = + new Resource$Projects$Locations$Featureonlinestores$Featureviews( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Operations( + this.context + ); + } + + /** + * Creates a new FeatureOnlineStore in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.create({ + * // Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featureOnlineStoreId: 'placeholder-value', + * // Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').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 a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.delete({ + * // If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + * force: 'placeholder-value', + * // Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * 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$Featureonlinestores$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 details of a single FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.get({ + * // Required. The name of the FeatureOnlineStore resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "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$Featureonlinestores$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.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/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "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$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').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); + } + } + + /** + * Lists FeatureOnlineStores in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.list({ + * // Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureOnlineStores": [], + * // "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$Featureonlinestores$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureOnlineStores').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 the parameters of a single FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.patch({ + * // Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * // Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigtable": {}, + * // "createTime": "my_createTime", + * // "dedicatedServingEndpoint": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "optimized": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.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/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "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$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions + ): Promise>; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options?: MethodOptions + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "permissions": [] + * // } + * } + * + * 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. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions + ): Promise>; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').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$Locations$Featureonlinestores$Create extends StandardParameters { + /** + * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureOnlineStoreId?: string; + /** + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete extends StandardParameters { + /** + * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + */ + force?: boolean; + /** + * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Get extends StandardParameters { + /** + * Required. The name of the FeatureOnlineStore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$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$Locations$Featureonlinestores$List extends StandardParameters { + /** + * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch extends StandardParameters { + /** + * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$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$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews { + context: APIRequestContext; + featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; + operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViewSyncs = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( + this.context + ); + } + + /** + * Creates a new FeatureView in a given FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.create( + * { + * // Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + * featureViewId: 'placeholder-value', + * // Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * // Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + * runSyncImmediately: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * }, + * }, + * ); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureViews').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 a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.delete( + * { + * // Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * 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$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite( + * { + * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dataKeyAndFeatureValues": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "status": {}, + * // "writeResponses": [] + * // } + * } + * + * 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. + */ + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: StreamMethodOptions + ): Promise>; + directWrite( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + directWrite( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + callback: BodyResponseCallback + ): void; + directWrite( + callback: BodyResponseCallback + ): void; + directWrite( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:directWrite').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetch feature values under a FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues( + * { + * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "dataFormat": "my_dataFormat", + * // "dataKey": {} + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "dataKey": {}, + * // "keyValues": {}, + * // "protoStruct": {} + * // } + * } + * + * 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. + */ + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions + ): Promise>; + fetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken( + * { + * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "accessToken": "my_accessToken", + * // "expireTime": "my_expireTime" + * // } + * } + * + * 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. + */ + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: StreamMethodOptions + ): Promise>; + generateFetchAccessToken( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + callback: BodyResponseCallback + ): void; + generateFetchAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+featureView}:generateFetchAccessToken' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.get({ + * // Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * } + * + * 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$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.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/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "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$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').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); + } + } + + /** + * Lists FeatureViews in a given FeatureOnlineStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.list({ + * // Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "featureViews": [], + * // "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$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/featureViews').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 the parameters of a single FeatureView. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featureOnlineStores.featureViews.patch({ + * // Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * // Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigQuerySource": {}, + * // "bigtableMetadata": {}, + * // "createTime": "my_createTime", + * // "etag": "my_etag", + * // "featureRegistrySource": {}, + * // "indexConfig": {}, + * // "labels": {}, + * // "name": "my_name", + * // "optimizedConfig": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccountEmail": "my_serviceAccountEmail", + * // "serviceAgentType": "my_serviceAgentType", + * // "syncConfig": {}, + * // "updateTime": "my_updateTime", + * // "vertexRagSource": {} + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Endpoints$Google$Science { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. * @example * ```js * // Before running the sample: @@ -74900,10 +91442,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -74912,29 +91451,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.endpoints.google.science.inference({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/google', + * await aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities( + * { + * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "query": {}, + * // "returnFullEntity": false + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "nearestNeighbors": {} * // } * } * @@ -74950,54 +91487,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - inference( - params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options: StreamMethodOptions ): Promise>; - inference( - params?: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + searchNearestEntities( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options?: MethodOptions - ): Promise>; - inference( - params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, + ): Promise< + GaxiosResponseWithHTTP2 + >; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - inference( - params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - inference( - params: Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference, - callback: BodyResponseCallback + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + callback: BodyResponseCallback ): void; - inference(callback: BodyResponseCallback): void; - inference( + searchNearestEntities( + callback: BodyResponseCallback + ): void; + searchNearestEntities( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; options = {}; } @@ -75010,7 +91555,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/science/inference').replace( + url: (rootUrl + '/v1/{+featureView}:searchNearestEntities').replace( /([^:]\/)\/+/g, '$1' ), @@ -75020,45 +91565,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Google$Science$Inference extends StandardParameters { - /** - * ID of the DeployedModel that serves the invoke request. - */ - deployedModelId?: string; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - - export class Resource$Projects$Locations$Endpoints$Invoke { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -75079,10 +91603,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -75090,28 +91611,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.invoke.invoke({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * - * invokeId: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.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/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "httpBody": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -75127,54 +91649,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options: StreamMethodOptions ): Promise>; - invoke( - params?: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options?: MethodOptions - ): Promise>; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + callback: BodyResponseCallback ): void; - invoke(callback: BodyResponseCallback): void; - invoke( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; options = {}; } @@ -75187,7 +91711,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -75197,45 +91721,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint', 'invokeId'], - pathParams: ['endpoint', 'invokeId'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Invoke$Invoke extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - /** - * - */ - invokeId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; - } - - export class Resource$Projects$Locations$Endpoints$Openapi { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Triggers on-demand sync for the FeatureView. * @example * ```js * // Before running the sample: @@ -75256,10 +91757,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -75267,31 +91765,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.openapi.completions( - * { - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.sync({ + * // Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * featureView: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * }, - * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "featureViewSync": "my_featureViewSync" * // } * } * @@ -75307,54 +91797,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completions( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions ): Promise>; - completions( - params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + sync( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options?: MethodOptions - ): Promise>; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, + ): Promise< + GaxiosResponseWithHTTP2 + >; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completions( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Completions, - callback: BodyResponseCallback + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + callback: BodyResponseCallback ): void; - completions(callback: BodyResponseCallback): void; - completions( + sync( + callback: BodyResponseCallback + ): void; + sync( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Openapi$Completions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Completions; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; options = {}; } @@ -75367,7 +91865,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/completions').replace( + url: (rootUrl + '/v1/{+featureView}:sync').replace( /([^:]\/)\/+/g, '$1' ), @@ -75377,22 +91875,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['featureView'], + pathParams: ['featureView'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -75413,10 +91913,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -75424,29 +91921,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.openapi.embeddings({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "permissions": [] * // } * } * @@ -75462,54 +91951,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options: StreamMethodOptions ): Promise>; - embeddings( - params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options?: MethodOptions - ): Promise>; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - embeddings( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + callback: BodyResponseCallback ): void; - embeddings(callback: BodyResponseCallback): void; - embeddings( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; options = {}; } @@ -75522,7 +92019,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/embeddings').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -75532,22 +92029,186 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create extends StandardParameters { /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + */ + featureViewId?: string; + /** + * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + /** + * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + */ + runSyncImmediately?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete extends StandardParameters { + /** + * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite extends StandardParameters { + /** + * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureViewDirectWriteRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken extends StandardParameters { + /** + * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get extends StandardParameters { + /** + * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Locations$Featureonlinestores$Featureviews$List extends StandardParameters { + /** + * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch extends StandardParameters { + /** + * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SearchNearestEntitiesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single FeatureViewSync. * @example * ```js * // Before running the sample: @@ -75568,10 +92229,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -75579,29 +92237,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.openapi.responses({ - * // ID of the DeployedModel that serves the invoke request. - * deployedModelId: 'placeholder-value', - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'projects/my-project/locations/my-location/endpoints/openapi', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get( + * { + * // Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/featureViewSyncs/my-featureViewSync', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "createTime": "my_createTime", + * // "finalStatus": {}, + * // "name": "my_name", + * // "runTime": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "syncSummary": {} * // } * } * @@ -75617,54 +92270,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - responses( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions ): Promise>; - responses( - params?: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options?: MethodOptions - ): Promise>; - responses( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - responses( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - responses( - params: Params$Resource$Projects$Locations$Endpoints$Openapi$Responses, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + callback: BodyResponseCallback ): void; - responses(callback: BodyResponseCallback): void; - responses( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Openapi$Responses - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Openapi$Responses; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Openapi$Responses; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; options = {}; } @@ -75677,85 +92338,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/responses').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Completions extends StandardParameters { - /** - * ID of the DeployedModel that serves the invoke request. - */ - deployedModelId?: string; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Embeddings extends StandardParameters { - /** - * ID of the DeployedModel that serves the invoke request. - */ - deployedModelId?: string; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - export interface Params$Resource$Projects$Locations$Endpoints$Openapi$Responses extends StandardParameters { - /** - * ID of the DeployedModel that serves the invoke request. - */ - deployedModelId?: string; - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleApiHttpBody; - } - - export class Resource$Projects$Locations$Endpoints$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Lists FeatureViewSyncs in a given FeatureView. * @example * ```js * // Before running the sample: @@ -75784,14 +92391,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list( + * { + * // Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` + * orderBy: 'placeholder-value', + * // The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * parent: + * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "featureViewSyncs": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -75806,54 +92428,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; options = {}; } @@ -75866,26 +92496,67 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get extends StandardParameters { + /** + * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List extends StandardParameters { + /** + * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. @@ -75917,10 +92588,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -75940,31 +92614,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Delete + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -75980,13 +92654,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; options = {}; } @@ -76050,10 +92724,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -76079,27 +92756,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -76107,7 +92783,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Get + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76123,13 +92799,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Get; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; options = {}; } @@ -76193,18 +92869,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -76227,38 +92906,38 @@ export namespace aiplatform_v1 { * @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$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Endpoints$Operations$List, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, callback: BodyResponseCallback ): void; - list( + listWait( callback: BodyResponseCallback ): void; - list( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$List + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76276,13 +92955,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; options = {}; } @@ -76295,10 +92974,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -76351,12 +93027,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.endpoints.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/endpoints/my-endpoint/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -76382,27 +93061,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Endpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -76410,7 +93088,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpoints$Operations$Wait + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76426,13 +93104,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpoints$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; options = {}; } @@ -76467,25 +93145,19 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait extends StandardParameters { /** * The standard list filter. */ @@ -76507,7 +93179,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Endpoints$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -76518,14 +93190,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Evaluationitems { + export class Resource$Projects$Locations$Featureonlinestores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an Evaluation Item. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -76554,42 +93226,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.create({ - * // Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name" - * // } + * // {} * } * * main().catch(e => { @@ -76604,62 +93249,54 @@ export namespace aiplatform_v1 { * @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$Evaluationitems$Create, + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluationitems$Create, + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationitems$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$Create; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluationitems$Create; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; options = {}; } @@ -76672,34 +93309,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Evaluation Item. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -76728,10 +93360,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.delete({ - * // Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` - * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -76756,36 +93389,35 @@ export namespace aiplatform_v1 { * @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$Evaluationitems$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Evaluationitems$Delete, + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationitems$Delete, + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Delete + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76801,13 +93433,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$Delete; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluationitems$Delete; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; options = {}; } @@ -76821,7 +93453,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -76842,7 +93474,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Evaluation Item. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -76871,24 +93503,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.get({ - * // Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` - * name: 'projects/my-project/locations/my-location/evaluationItems/my-evaluationItem', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.listWait( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationItemType": "my_evaluationItemType", - * // "evaluationRequest": {}, - * // "evaluationResponse": {}, - * // "gcsUri": "my_gcsUri", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -76904,61 +93540,62 @@ export namespace aiplatform_v1 { * @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$Evaluationitems$Get, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Evaluationitems$Get, + listWait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationitems$Get, - callback: BodyResponseCallback + listWait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + listWait( + callback: BodyResponseCallback ): void; - get( + listWait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait + | 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$Evaluationitems$Get; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationitems$Get; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; options = {}; } @@ -76971,7 +93608,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -76983,19 +93620,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Evaluation Items. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -77024,24 +93661,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationItems.list({ - * // Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Items to return. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.featureOnlineStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "evaluationItems": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -77057,61 +93692,57 @@ export namespace aiplatform_v1 { * @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$Evaluationitems$List, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Evaluationitems$List, + wait( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationitems$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationitems$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationitems$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationitems$List; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; options = {}; } @@ -77124,87 +93755,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationItems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Evaluationitems$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Evaluation Item in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationItem; - } - export interface Params$Resource$Projects$Locations$Evaluationitems$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete extends StandardParameters { /** - * Required. The name of the EvaluationItem resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationitems$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get extends StandardParameters { /** - * Required. The name of the EvaluationItem resource. Format: `projects/{project\}/locations/{location\}/evaluationItems/{evaluation_item\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationitems$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the EvaluationItems to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The maximum number of Evaluation Items to return. + * The standard list page size. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListEvaluationItems` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Evaluation Items. Format: `projects/{project\}/locations/{location\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Evaluationruns { + export class Resource$Projects$Locations$Featurestores { context: APIRequestContext; + entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; + operations: Resource$Projects$Locations$Featurestores$Operations; constructor(context: APIRequestContext) { this.context = context; + this.entityTypes = + new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); + this.operations = + new Resource$Projects$Locations$Featurestores$Operations(this.context); } /** - * Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run asynchronously. Status of run can be checked via GetEvaluationRun. + * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. * @example * ```js * // Before running the sample: @@ -77233,20 +93864,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.cancel({ - * // Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * const res = + * await aiplatform.projects.locations.featurestores.batchReadFeatureValues({ + * // Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * featurestore: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "bigqueryReadInstances": {}, + * // "csvReadInstances": {}, + * // "destination": {}, + * // "entityTypeSpecs": [], + * // "passThroughFields": [], + * // "startTime": "my_startTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -77261,53 +93907,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + batchReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, + ): Promise>; + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Evaluationruns$Cancel, - callback: BodyResponseCallback + batchReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchReadFeatureValues( + callback: BodyResponseCallback + ): void; + batchReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Cancel; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; options = {}; } @@ -77320,29 +93970,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['featurestore'], + pathParams: ['featurestore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an Evaluation Run. + * Creates a new Featurestore in a given project and location. * @example * ```js * // Before running the sample: @@ -77371,27 +94023,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.create({ - * // Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.featurestores.create({ + * // Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + * featurestoreId: 'placeholder-value', + * // Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "completionTime": "my_completionTime", * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", * // "labels": {}, - * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state" + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -77399,19 +94051,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "completionTime": "my_completionTime", - * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", + * // "done": false, * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, - * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state" + * // "response": {} * // } * } * @@ -77428,60 +94072,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Evaluationruns$Create, + params?: Params$Resource$Projects$Locations$Featurestores$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, + params: Params$Resource$Projects$Locations$Featurestores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, + params: Params$Resource$Projects$Locations$Featurestores$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Evaluationruns$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Create; + params = {} as Params$Resource$Projects$Locations$Featurestores$Create; options = {}; } @@ -77494,7 +94133,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( + url: (rootUrl + '/v1/{+parent}/featurestores').replace( /([^:]\/)\/+/g, '$1' ), @@ -77509,19 +94148,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Evaluation Run. + * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. * @example * ```js * // Before running the sample: @@ -77550,9 +94187,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.delete({ - * // Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * const res = await aiplatform.projects.locations.featurestores.delete({ + * // If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) + * force: 'placeholder-value', + * // Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', * }); * console.log(res.data); * @@ -77579,27 +94218,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Evaluationruns$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Evaluationruns$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Delete, callback: BodyResponseCallback ): void; delete( @@ -77607,7 +94245,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Delete + | Params$Resource$Projects$Locations$Featurestores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -77623,12 +94261,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Delete; + params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; options = {}; } @@ -77663,7 +94301,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Evaluation Run. + * Gets details of a single Featurestore. * @example * ```js * // Before running the sample: @@ -77692,27 +94330,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.get({ - * // Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - * name: 'projects/my-project/locations/my-location/evaluationRuns/my-evaluationRun', + * const res = await aiplatform.projects.locations.featurestores.get({ + * // Required. The name of the Featurestore resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', * }); * console.log(res.data); * * // Example response * // { - * // "completionTime": "my_completionTime", * // "createTime": "my_createTime", - * // "dataSource": {}, - * // "displayName": "my_displayName", - * // "error": {}, - * // "evaluationConfig": {}, - * // "evaluationResults": {}, - * // "evaluationSetSnapshot": "my_evaluationSetSnapshot", - * // "inferenceConfigs": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", * // "labels": {}, - * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state" + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -77729,60 +94365,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + params: Params$Resource$Projects$Locations$Featurestores$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Evaluationruns$Get, + params?: Params$Resource$Projects$Locations$Featurestores$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + params: Params$Resource$Projects$Locations$Featurestores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, + params: Params$Resource$Projects$Locations$Featurestores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluationruns$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Get + | 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$Evaluationruns$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$Get; + params = {} as Params$Resource$Projects$Locations$Featurestores$Get; options = {}; } @@ -77807,19 +94443,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Evaluation Runs. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -77848,24 +94484,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationRuns.list({ - * // Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Runs to return. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.featurestores.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/locations/my-location/featurestores/my-featurestore', * }); * console.log(res.data); * * // Example response * // { - * // "evaluationRuns": [], - * // "nextPageToken": "my_nextPageToken" + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -77881,61 +94513,56 @@ export namespace aiplatform_v1 { * @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$Evaluationruns$List, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Evaluationruns$List, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationruns$List, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - list( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationruns$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationruns$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationruns$List; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; options = {}; } @@ -77948,98 +94575,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationRuns').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Evaluationruns$Cancel extends StandardParameters { - /** - * Required. The name of the EvaluationRun resource to be cancelled. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelEvaluationRunRequest; - } - export interface Params$Resource$Projects$Locations$Evaluationruns$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Evaluation Run in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationRun; - } - export interface Params$Resource$Projects$Locations$Evaluationruns$Delete extends StandardParameters { - /** - * Required. The name of the EvaluationRun resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Evaluationruns$Get extends StandardParameters { - /** - * Required. The name of the EvaluationRun resource. Format: `projects/{project\}/locations/{location\}/evaluationRuns/{evaluation_run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Evaluationruns$List extends StandardParameters { - /** - * Optional. Filter expression that matches a subset of the EvaluationRuns to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - */ - orderBy?: string; - /** - * Optional. The maximum number of Evaluation Runs to return. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListEvaluationRuns` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the Evaluation Runs. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Evaluationsets { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates an Evaluation Set. + * Lists Featurestores in a given project and location. * @example * ```js * // Before running the sample: @@ -78068,33 +94629,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.create({ - * // Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.featurestores.list({ + * // Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` + * orderBy: 'placeholder-value', + * // The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "featurestores": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -78110,61 +94664,61 @@ export namespace aiplatform_v1 { * @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$Evaluationsets$Create, + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Evaluationsets$Create, + list( + params?: Params$Resource$Projects$Locations$Featurestores$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, + list( + params: Params$Resource$Projects$Locations$Featurestores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Evaluationsets$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$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$Evaluationsets$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Create; + params = {} as Params$Resource$Projects$Locations$Featurestores$List; options = {}; } @@ -78177,11 +94731,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( + url: (rootUrl + '/v1/{+parent}/featurestores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -78192,19 +94746,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an Evaluation Set. + * Updates the parameters of a single Featurestore. * @example * ```js * // Before running the sample: @@ -78233,9 +94787,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.delete({ - * // Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * const res = await aiplatform.projects.locations.featurestores.patch({ + * // Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "onlineServingConfig": {}, + * // "onlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -78261,36 +94835,35 @@ export namespace aiplatform_v1 { * @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$Evaluationsets$Delete, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Evaluationsets$Delete, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Patch, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Evaluationsets$Delete, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Patch, callback: BodyResponseCallback ): void; - delete( + patch( callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Delete + | Params$Resource$Projects$Locations$Featurestores$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -78306,12 +94879,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Delete; + params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; options = {}; } @@ -78325,7 +94898,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -78346,7 +94919,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Evaluation Set. + * Searches Features matching a query in a given project. * @example * ```js * // Before running the sample: @@ -78375,20 +94948,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.get({ - * // Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', + * const res = await aiplatform.projects.locations.featurestores.searchFeatures({ + * // Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + * location: 'projects/my-project/locations/my-location', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. + * query: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "features": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -78404,61 +94979,62 @@ export namespace aiplatform_v1 { * @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$Evaluationsets$Get, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Evaluationsets$Get, + searchFeatures( + params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Evaluationsets$Get, - callback: BodyResponseCallback + searchFeatures( + params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchFeatures( + callback: BodyResponseCallback ): void; - get( + searchFeatures( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Searchfeatures + | 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$Evaluationsets$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Get; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; options = {}; } @@ -78471,31 +95047,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+location}/featurestores:searchFeatures' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Evaluation Sets. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -78524,24 +95102,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.evaluationSets.list({ - * // Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of Evaluation Sets to return. - * pageSize: 'placeholder-value', - * // Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.featurestores.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/locations/my-location/featurestores/my-featurestore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "evaluationSets": [], - * // "nextPageToken": "my_nextPageToken" + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -78557,61 +95137,56 @@ export namespace aiplatform_v1 { * @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$Evaluationsets$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Evaluationsets$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Evaluationsets$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - list( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluationsets$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$List; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; options = {}; } @@ -78624,34 +95199,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluationSets').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an Evaluation Set. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -78663,52 +95236,36 @@ export namespace aiplatform_v1 { * // ``` * // - Install the npm module by running: * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('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 aiplatform.projects.locations.evaluationSets.patch({ - * // Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` - * name: 'projects/my-project/locations/my-location/evaluationSets/my-evaluationSet', - * // Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('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 aiplatform.projects.locations.featurestores.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "evaluationItems": [], - * // "metadata": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "permissions": [] * // } * } * @@ -78724,61 +95281,62 @@ export namespace aiplatform_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$Evaluationsets$Patch, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Evaluationsets$Patch, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Evaluationsets$Patch, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - patch( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluationsets$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Testiampermissions + | 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$Evaluationsets$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Evaluationsets$Patch; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; options = {}; } @@ -78791,106 +95349,184 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Evaluationsets$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues extends StandardParameters { /** - * Required. The resource name of the Location to create the Evaluation Set in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + */ + featurestore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Create extends StandardParameters { + /** + * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featurestoreId?: string; + /** + * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Delete extends StandardParameters { /** - * Required. The name of the EvaluationSet resource to be deleted. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) + */ + force?: boolean; + /** + * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Get extends StandardParameters { /** - * Required. The name of the EvaluationSet resource. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * Required. The name of the Featurestore resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Getiampolicy extends StandardParameters { /** - * Optional. Filter expression that matches a subset of the EvaluationSets to show. For field names both snake_case and camelCase are supported. For more information about filter syntax, see [AIP-160](https://google.aip.dev/160). + * 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$Locations$Featurestores$List extends StandardParameters { + /** + * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order by default. Use `desc` after a field name for descending. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` */ orderBy?: string; /** - * Optional. The maximum number of Evaluation Sets to return. + * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListEvaluationSets` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Evaluation Sets. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Evaluationsets$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Patch extends StandardParameters { /** - * Identifier. The resource name of the EvaluationSet. Format: `projects/{project\}/locations/{location\}/evaluationSets/{evaluation_set\}` + * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ name?: string; /** - * Optional. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1EvaluationSet; + requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; + } + export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures extends StandardParameters { + /** + * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` + */ + location?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. + */ + pageToken?: string; + /** + * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. + */ + query?: string; } + export interface Params$Resource$Projects$Locations$Featurestores$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; - export class Resource$Projects$Locations$Featuregroups { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes { context: APIRequestContext; - features: Resource$Projects$Locations$Featuregroups$Features; - operations: Resource$Projects$Locations$Featuregroups$Operations; + features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.features = new Resource$Projects$Locations$Featuregroups$Features( - this.context - ); + this.features = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features( + this.context + ); this.operations = - new Resource$Projects$Locations$Featuregroups$Operations(this.context); + new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( + this.context + ); } /** - * Creates a new FeatureGroup in a given project and location. + * Creates a new EntityType in a given Featurestore. * @example * ```js * // Before running the sample: @@ -78919,28 +95555,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.create({ - * // Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featureGroupId: 'placeholder-value', - * // Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.create({ + * // Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. + * entityTypeId: 'placeholder-value', + * // Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -78966,27 +95605,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Featuregroups$Create, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Featuregroups$Create, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, callback: BodyResponseCallback ): void; create( @@ -78994,7 +95632,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Create + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -79010,12 +95648,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; options = {}; } @@ -79028,7 +95667,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -79053,7 +95692,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a single FeatureGroup. + * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. * @example * ```js * // Before running the sample: @@ -79082,12 +95721,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.delete({ - * // If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) - * force: 'placeholder-value', - * // Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.delete({ + * // If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) + * force: 'placeholder-value', + * // Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }); * console.log(res.data); * * // Example response @@ -79113,27 +95753,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, callback: BodyResponseCallback ): void; delete( @@ -79141,7 +95780,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Delete + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -79157,12 +95796,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; options = {}; } @@ -79197,7 +95837,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of a single FeatureGroup. + * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. * @example * ```js * // Before running the sample: @@ -79226,23 +95866,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.get({ - * // Required. The name of the FeatureGroup resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues( + * { + * // Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "selectEntity": {}, + * // "selectTimeRangeAndFeature": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -79258,61 +95907,57 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Get, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Get, + deleteFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + ): Promise>; + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Get, - callback: BodyResponseCallback + deleteFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + deleteFeatureValues( + callback: BodyResponseCallback ): void; - get( + deleteFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; options = {}; } @@ -79325,31 +95970,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Exports Feature values from all the entities of a target EntityType. * @example * ```js * // Before running the sample: @@ -79378,20 +96024,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.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/locations/my-location/featureGroups/my-featureGroup', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues( + * { + * // Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "destination": {}, + * // "featureSelector": {}, + * // "fullExport": {}, + * // "settings": [], + * // "snapshotExport": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -79407,56 +96068,57 @@ export namespace aiplatform_v1 { * @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$Locations$Featuregroups$Getiampolicy, + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + exportFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, + ): Promise>; + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Getiampolicy, - callback: BodyResponseCallback + exportFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + exportFeatureValues( + callback: BodyResponseCallback ): void; - getIamPolicy( + exportFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; options = {}; } @@ -79469,7 +96131,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), @@ -79479,22 +96141,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists FeatureGroups in a given project and location. + * Gets details of a single EntityType. * @example * ```js * // Before running the sample: @@ -79523,24 +96185,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.list({ - * // Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = await aiplatform.projects.locations.featurestores.entityTypes.get( + * { + * // Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "featureGroups": [], - * // "nextPageToken": "my_nextPageToken" + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -79556,61 +96220,62 @@ export namespace aiplatform_v1 { * @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$Featuregroups$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$List, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get + | 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$Featuregroups$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$List; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; options = {}; } @@ -79623,34 +96288,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureGroups').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single FeatureGroup. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -79679,37 +96341,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.patch({ - * // Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * // Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuery": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.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/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -79725,57 +96371,56 @@ export namespace aiplatform_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$Featuregroups$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - patch( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; + params = + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; options = {}; } @@ -79788,29 +96433,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. * @example * ```js * // Before running the sample: @@ -79839,26 +96487,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.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/locations/my-location/featureGroups/my-featureGroup', + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues( + * { + * // Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "avroSource": {}, + * // "bigquerySource": {}, + * // "csvSource": {}, + * // "disableIngestionAnalysis": false, + * // "disableOnlineServing": false, + * // "entityIdField": "my_entityIdField", + * // "featureSpecs": [], + * // "featureTime": "my_featureTime", + * // "featureTimeField": "my_featureTimeField", + * // "workerCount": 0 + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -79874,56 +96536,57 @@ export namespace aiplatform_v1 { * @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$Locations$Featuregroups$Setiampolicy, + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + importFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, + ): Promise>; + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featuregroups$Setiampolicy, - callback: BodyResponseCallback + importFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + importFeatureValues( + callback: BodyResponseCallback ): void; - setIamPolicy( + importFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; options = {}; } @@ -79936,7 +96599,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), @@ -79946,22 +96609,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists EntityTypes in a given Featurestore. * @example * ```js * // Before running the sample: @@ -79991,18 +96654,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * await aiplatform.projects.locations.featurestores.entityTypes.list({ + * // Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "entityTypes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -80018,62 +96690,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featuregroups$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$Featuregroups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; options = {}; } @@ -80086,146 +96758,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/entityTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Create extends StandardParameters { - /** - * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureGroupId?: string; - /** - * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Delete extends StandardParameters { - /** - * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) - */ - force?: boolean; - /** - * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Get extends StandardParameters { - /** - * Required. The name of the FeatureGroup resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$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$Locations$Featuregroups$List extends StandardParameters { - /** - * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureRegistryService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureRegistryService.ListFeatureGroups must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Patch extends StandardParameters { - /** - * Identifier. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` * `service_agent_type` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureGroup; - } - export interface Params$Resource$Projects$Locations$Featuregroups$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Features { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featuregroups$Features$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featuregroups$Features$Operations( - this.context + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters ); + } } /** - * Creates a batch of Features in a given FeatureGroup. + * Updates the parameters of a single EntityType. * @example * ```js * // Before running the sample: @@ -80255,16 +96815,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.features.batchCreate({ - * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * await aiplatform.projects.locations.featurestores.entityTypes.patch({ + * // Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "requests": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, + * // "name": "my_name", + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -80272,11 +96842,16 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringConfig": {}, * // "name": "my_name", - * // "response": {} + * // "offlineStorageTtlDays": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -80292,58 +96867,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchCreate( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; options = {}; } @@ -80356,32 +96935,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new Feature in a given FeatureGroup. + * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. * @example * ```js * // Before running the sample: @@ -80410,42 +96988,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.create( - * { - * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - * featureId: 'placeholder-value', - * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues( + * { + * // Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entityId": "my_entityId", + * // "featureSelector": {} + * // } + * }, * }, - * }, - * ); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "entityView": {}, + * // "header": {} * // } * } * @@ -80461,58 +97026,62 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$Create, + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + readFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, - callback: BodyResponseCallback + readFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + readFeatureValues( + callback: BodyResponseCallback ): void; - create( + readFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; options = {}; } @@ -80525,7 +97094,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( /([^:]\/)\/+/g, '$1' ), @@ -80535,22 +97104,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single Feature. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -80579,21 +97150,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.delete( - * { - * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * }, - * ); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.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/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -80609,58 +97186,56 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - delete( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; options = {}; } @@ -80673,29 +97248,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Feature. + * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. * @example * ```js * // Before running the sample: @@ -80724,25 +97302,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.get({ - * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues( + * { + * // Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "entityIds": [], + * // "featureSelector": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" + * // "entityView": {}, + * // "header": {} * // } * } * @@ -80758,58 +97340,62 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$Get, + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + streamingReadFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, - callback: BodyResponseCallback + streamingReadFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + streamingReadFeatureValues( + callback: BodyResponseCallback ): void; - get( + streamingReadFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; options = {}; } @@ -80822,31 +97408,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Features in a given FeatureGroup. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -80875,29 +97463,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.list({ - * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - * latestStatsCount: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featureGroups/my-featureGroup', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "features": [], - * // "nextPageToken": "my_nextPageToken" + * // "permissions": [] * // } * } * @@ -80913,62 +97493,62 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions + | 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$Featuregroups$Features$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; options = {}; } @@ -80981,34 +97561,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. * @example * ```js * // Before running the sample: @@ -81037,40 +97617,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.features.patch({ - * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature', - * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues( + * { + * // Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + * entityType: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "payloads": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -81085,58 +97651,62 @@ export namespace aiplatform_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$Featuregroups$Features$Patch, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + writeFeatureValues( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, - callback: BodyResponseCallback + writeFeatureValues( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + writeFeatureValues( + callback: BodyResponseCallback ): void; - patch( + writeFeatureValues( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; options = {}; } @@ -81149,89 +97719,126 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['entityType'], + pathParams: ['entityType'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Batchcreate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create extends StandardParameters { /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. + */ + entityTypeId?: string; + /** + * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete extends StandardParameters { /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) */ - featureId?: string; + force?: boolean; /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ - parent?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues extends StandardParameters { + /** + * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + */ + entityType?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues extends StandardParameters { /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ - name?: string; + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get extends StandardParameters { /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy extends StandardParameters { /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * 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). */ - filter?: string; + 'options.requestedPolicyVersion'?: number; /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + * 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. */ - latestStatsCount?: number; + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues extends StandardParameters { /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List extends StandardParameters { + /** + * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` */ orderBy?: string; /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` */ parent?: string; /** @@ -81239,30 +97846,89 @@ export namespace aiplatform_v1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch extends StandardParameters { /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1EntityType; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$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; - export class Resource$Projects$Locations$Featuregroups$Features$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues extends StandardParameters { + /** + * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues extends StandardParameters { + /** + * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. + */ + entityType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { context: APIRequestContext; + operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( + this.context + ); } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a batch of Features in a given EntityType. * @example * ```js * // Before running the sample: @@ -81292,16 +97958,31 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.delete( + * await aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate( * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', + * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -81316,54 +97997,57 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$Operations$Delete, + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + batchCreate( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + ): Promise>; + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; options = {}; } @@ -81376,29 +98060,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Creates a new Feature in a given EntityType. * @example * ```js * // Before running the sample: @@ -81428,10 +98115,33 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * }); + * await aiplatform.projects.locations.featurestores.entityTypes.features.create( + * { + * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * featureId: 'placeholder-value', + * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -81456,36 +98166,35 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Features$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -81501,13 +98210,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; options = {}; } @@ -81520,15 +98229,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -81542,7 +98254,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a single Feature. * @example * ```js * // Before running the sample: @@ -81572,27 +98284,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.listWait( + * await aiplatform.projects.locations.featurestores.entityTypes.features.delete( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -81608,62 +98314,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - listWait( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; options = {}; } @@ -81676,8 +98377,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -81688,19 +98389,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets details of a single Feature. * @example * ```js * // Before running the sample: @@ -81730,21 +98429,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.features.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/features/my-feature/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.projects.locations.featurestores.entityTypes.features.get({ + * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], * // "name": "my_name", - * // "response": {} + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" * // } * } * @@ -81760,58 +98463,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; options = {}; } @@ -81824,8 +98527,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -81836,69 +98539,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featuregroups$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists Features in a given EntityType. * @example * ```js * // Before running the sample: @@ -81928,14 +98581,32 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * }); + * await aiplatform.projects.locations.featurestores.entityTypes.features.list( + * { + * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * filter: 'placeholder-value', + * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + * latestStatsCount: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * parent: + * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "features": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -81950,54 +98621,62 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; options = {}; } @@ -82010,29 +98689,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates the parameters of a single Feature. * @example * ```js * // Before running the sample: @@ -82061,19 +98745,48 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.patch( + * { + * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], + * // "name": "my_name", + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMonitoring": false, + * // "etag": "my_etag", + * // "labels": {}, + * // "monitoringStatsAnomalies": [], * // "name": "my_name", - * // "response": {} + * // "pointOfContact": "my_pointOfContact", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType", + * // "versionColumnName": "my_versionColumnName" * // } * } * @@ -82089,58 +98802,58 @@ export namespace aiplatform_v1 { * @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$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; options = {}; } @@ -82154,7 +98867,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -82165,17 +98878,110 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get extends StandardParameters { + /** + * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Feature; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -82205,26 +99011,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureGroups.operations.listWait({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -82239,62 +99035,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listWait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + callback: BodyResponseCallback ): void; - listWait( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; options = {}; } @@ -82307,8 +99095,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -82319,19 +99107,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -82360,24 +99146,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureGroups.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureGroups/my-featureGroup/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -82392,58 +99171,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + callback: BodyResponseCallback ): void; - wait( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; options = {}; } @@ -82456,8 +99231,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -82468,79 +99243,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores { - context: APIRequestContext; - featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; - operations: Resource$Projects$Locations$Featureonlinestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.featureViews = - new Resource$Projects$Locations$Featureonlinestores$Featureviews( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Operations( - this.context - ); - } /** - * Creates a new FeatureOnlineStore in a given project and location. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -82569,31 +99282,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.create({ - * // Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featureOnlineStoreId: 'placeholder-value', - * // Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -82618,36 +99313,35 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Create, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Create + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -82663,13 +99357,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; options = {}; } @@ -82682,18 +99376,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -82707,7 +99398,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -82736,21 +99427,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.delete({ - * // If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) - * force: 'placeholder-value', - * // Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -82766,58 +99464,62 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Delete, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; options = {}; } @@ -82830,8 +99532,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -82842,17 +99547,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single FeatureOnlineStore. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -82881,26 +99588,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.get({ - * // Required. The name of the FeatureOnlineStore resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -82916,62 +99621,57 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Get, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Get, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; options = {}; } @@ -82984,8 +99684,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -82996,19 +99696,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -83038,21 +99794,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.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/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * await aiplatform.projects.locations.featurestores.entityTypes.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -83067,56 +99818,54 @@ export namespace aiplatform_v1 { * @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$Locations$Featureonlinestores$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; options = {}; } @@ -83129,32 +99878,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists FeatureOnlineStores in a given project and location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -83183,25 +99929,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.list({ - * // Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "featureOnlineStores": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -83216,62 +99954,54 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$List, + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + delete( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; options = {}; } @@ -83284,34 +100014,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureOnlineStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single FeatureOnlineStore. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -83340,31 +100065,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featureOnlineStores.patch({ - * // Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * // Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigtable": {}, - * // "createTime": "my_createTime", - * // "dedicatedServingEndpoint": {}, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "optimized": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.featurestores.entityTypes.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -83389,36 +100096,35 @@ export namespace aiplatform_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$Featureonlinestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + get( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -83434,13 +100140,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; options = {}; } @@ -83454,7 +100160,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -83475,7 +100181,7 @@ export namespace aiplatform_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -83505,26 +100211,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.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/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } + * await aiplatform.projects.locations.featurestores.entityTypes.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -83540,56 +100247,62 @@ export namespace aiplatform_v1 { * @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$Locations$Featureonlinestores$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; options = {}; } @@ -83602,32 +100315,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -83657,18 +100372,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * }); + * await aiplatform.projects.locations.featurestores.entityTypes.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -83684,62 +100404,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - testIamPermissions( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions; + {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; options = {}; } @@ -83752,151 +100467,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Create extends StandardParameters { - /** - * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featureOnlineStoreId?: string; - /** - * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete extends StandardParameters { - /** - * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) - */ - force?: boolean; + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel extends StandardParameters { /** - * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete extends StandardParameters { /** - * Required. The name of the FeatureOnlineStore resource. + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$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; + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get extends StandardParameters { /** - * 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. + * The name of the operation resource. */ - resource?: string; + name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List extends StandardParameters { /** - * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait extends StandardParameters { /** - * Identifier. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - resource?: string; + timeout?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Featureviews { + export class Resource$Projects$Locations$Featurestores$Operations { context: APIRequestContext; - featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; - operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; constructor(context: APIRequestContext) { this.context = context; - this.featureViewSyncs = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( - this.context - ); } /** - * Creates a new FeatureView in a given FeatureOnlineStore. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -83926,50 +100577,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.create( - * { - * // Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. - * featureViewId: 'placeholder-value', - * // Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', - * // Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - * runSyncImmediately: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, - * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.featurestores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -83984,58 +100599,54 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Create, + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + cancel( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; options = {}; } @@ -84048,32 +100659,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single FeatureView. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -84103,22 +100711,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.delete( - * { - * // Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * }, - * ); + * await aiplatform.projects.locations.featurestores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -84134,57 +100734,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; options = {}; } @@ -84209,17 +100805,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bidirectional streaming RPC to directly write to feature values in a feature view. Requests may not have a one-to-one mapping to responses and responses may be returned out-of-order to reduce latency. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -84248,28 +100844,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.directWrite( - * { - * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "dataKeyAndFeatureValues": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.featurestores.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "status": {}, - * // "writeResponses": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -84285,62 +100872,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions ): Promise>; - directWrite( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + get( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - directWrite( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + callback: BodyResponseCallback ): void; - directWrite( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - directWrite( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; options = {}; } @@ -84353,34 +100935,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:directWrite').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Fetch feature values under a FeatureView. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -84409,30 +100986,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues( - * { - * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "dataFormat": "my_dataFormat", - * // "dataKey": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.featurestores.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "dataKey": {}, - * // "keyValues": {}, - * // "protoStruct": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -84448,62 +101022,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions ): Promise>; - fetchFeatureValues( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + callback: BodyResponseCallback ): void; - fetchFeatureValues( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - fetchFeatureValues( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$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$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; options = {}; } @@ -84516,34 +101090,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:fetchFeatureValues').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * RPC to generate an access token for the given feature view. FeatureViews under the same FeatureOnlineStore share the same access token. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -84572,26 +101146,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.generateFetchAccessToken( - * { - * // FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.featurestores.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "accessToken": "my_accessToken", - * // "expireTime": "my_expireTime" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -84607,62 +101178,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions ): Promise>; - generateFetchAccessToken( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + wait( + params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateFetchAccessToken( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + callback: BodyResponseCallback ): void; - generateFetchAccessToken( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - generateFetchAccessToken( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken; + {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; options = {}; } @@ -84675,33 +101241,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+featureView}:generateFetchAccessToken' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featurestores$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Hyperparametertuningjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( + this.context ); - } } /** - * Gets details of a single FeatureView. + * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -84731,31 +101356,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.get({ - * // Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * await aiplatform.projects.locations.hyperparameterTuningJobs.cancel({ + * // Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response - * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, - * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} - * // } + * // {} * } * * main().catch(e => { @@ -84770,62 +101384,54 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Get, + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + cancel( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; options = {}; } @@ -84838,8 +101444,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -84850,19 +101456,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a HyperparameterTuningJob * @example * ```js * // Before running the sample: @@ -84892,22 +101496,57 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.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/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * await aiplatform.projects.locations.hyperparameterTuningJobs.create({ + * // Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, + * // "name": "my_name", + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, + * // "name": "my_name", + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -84923,56 +101562,62 @@ export namespace aiplatform_v1 { * @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$Locations$Featureonlinestores$Featureviews$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; options = {}; } @@ -84985,7 +101630,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -84995,22 +101640,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists FeatureViews in a given FeatureOnlineStore. + * Deletes a HyperparameterTuningJob. * @example * ```js * // Before running the sample: @@ -85040,25 +101687,19 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.list({ - * // Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore', + * await aiplatform.projects.locations.hyperparameterTuningJobs.delete({ + * // Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', * }); * console.log(res.data); * * // Example response * // { - * // "featureViews": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -85074,62 +101715,57 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$List, + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + delete( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; options = {}; } @@ -85142,34 +101778,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViews').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single FeatureView. + * Gets a HyperparameterTuningJob * @example * ```js * // Before running the sample: @@ -85198,45 +101829,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.patch({ - * // Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * // Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "bigQuerySource": {}, - * // "bigtableMetadata": {}, - * // "createTime": "my_createTime", - * // "etag": "my_etag", - * // "featureRegistrySource": {}, - * // "indexConfig": {}, - * // "labels": {}, - * // "name": "my_name", - * // "optimizedConfig": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccountEmail": "my_serviceAccountEmail", - * // "serviceAgentType": "my_serviceAgentType", - * // "syncConfig": {}, - * // "updateTime": "my_updateTime", - * // "vertexRagSource": {} - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.get({ + * // Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", * // "error": {}, - * // "metadata": {}, + * // "labels": {}, + * // "maxFailedTrialCount": 0, + * // "maxTrialCount": 0, * // "name": "my_name", - * // "response": {} + * // "parallelTrialCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "studySpec": {}, + * // "trialJobSpec": {}, + * // "trials": [], + * // "updateTime": "my_updateTime" * // } * } * @@ -85252,58 +101870,62 @@ export namespace aiplatform_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$Featureonlinestores$Featureviews$Patch, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + get( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; options = {}; } @@ -85317,7 +101939,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -85328,17 +101950,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. + * Lists HyperparameterTuningJobs in a Location. * @example * ```js * // Before running the sample: @@ -85367,28 +101991,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities( - * { - * // Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "query": {}, - * // "returnFullEntity": false - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.list( + * { + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nearestNeighbors": {} + * // "hyperparameterTuningJobs": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -85404,62 +102026,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions ): Promise>; - searchNearestEntities( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + list( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchNearestEntities( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + callback: BodyResponseCallback ): void; - searchNearestEntities( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchNearestEntities( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$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$Featureonlinestores$Featureviews$Searchnearestentities; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; options = {}; } @@ -85472,34 +102094,98 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:searchNearestEntities').replace( + url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + 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$Hyperparametertuningjobs$Cancel extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get extends StandardParameters { + /** + * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -85529,29 +102215,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.setIamPolicy( + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel( * { - * // 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/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -85566,56 +102239,54 @@ export namespace aiplatform_v1 { * @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$Locations$Featureonlinestores$Featureviews$Setiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - setIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; options = {}; } @@ -85628,32 +102299,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Triggers on-demand sync for the FeatureView. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -85683,23 +102351,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.sync({ - * // Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * featureView: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "featureViewSync": "my_featureViewSync" - * // } + * // {} * } * * main().catch(e => { @@ -85714,62 +102375,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - sync( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + delete( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - sync( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - sync( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + callback: BodyResponseCallback ): void; - sync( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; options = {}; } @@ -85782,34 +102435,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+featureView}:sync').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['featureView'], - pathParams: ['featureView'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -85839,20 +102487,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.testIamPermissions( + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.get( * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -85868,62 +102517,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + get( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - testIamPermissions( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; options = {}; } @@ -85933,199 +102577,32 @@ export namespace aiplatform_v1 { } const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').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$Locations$Featureonlinestores$Featureviews$Create extends StandardParameters { - /** - * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. - */ - featureViewId?: string; - /** - * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - /** - * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. - */ - runSyncImmediately?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete extends StandardParameters { - /** - * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Directwrite extends StandardParameters { - /** - * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureViewDirectWriteRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Generatefetchaccesstoken extends StandardParameters { - /** - * FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateFetchAccessTokenRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get extends StandardParameters { - /** - * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$Locations$Featureonlinestores$Featureviews$List extends StandardParameters { - /** - * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch extends StandardParameters { - /** - * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` * `optimized_config.automatic_resources` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FeatureView; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities extends StandardParameters { - /** - * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchNearestEntitiesRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync extends StandardParameters { - /** - * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - */ - featureView?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + 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 details of a single FeatureViewSync. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -86155,23 +102632,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get( + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.list( * { - * // Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/featureViewSyncs/my-featureViewSync', + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "finalStatus": {}, - * // "name": "my_name", - * // "runTime": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "syncSummary": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -86187,62 +102668,62 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + list( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$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$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; options = {}; } @@ -86255,7 +102736,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -86267,19 +102751,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists FeatureViewSyncs in a given FeatureView. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -86309,27 +102793,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list( + * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait( * { - * // Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` - * orderBy: 'placeholder-value', - * // The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` - * parent: - * 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView', + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "featureViewSyncs": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -86345,62 +102825,57 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Featureviewsyncs$List, + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + wait( + params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; + {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; options = {}; } @@ -86413,70 +102888,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featureViewSyncs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel extends StandardParameters { /** - * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete extends StandardParameters { /** - * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List extends StandardParameters { + /** + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { + export class Resource$Projects$Locations$Indexendpoints { context: APIRequestContext; + operations: Resource$Projects$Locations$Indexendpoints$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Indexendpoints$Operations(this.context); } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates an IndexEndpoint. * @example * ```js * // Before running the sample: @@ -86505,17 +103000,43 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.indexEndpoints.create({ + * // Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -86530,54 +103051,56 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Indexendpoints$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexendpoints$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; options = {}; } @@ -86590,29 +103113,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes an IndexEndpoint. * @example * ```js * // Before running the sample: @@ -86641,13 +103167,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.indexEndpoints.delete({ + * // Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * }); * console.log(res.data); * * // Example response @@ -86672,36 +103195,35 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Featureviews$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get + | Params$Resource$Projects$Locations$Indexendpoints$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -86717,13 +103239,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; options = {}; } @@ -86737,7 +103258,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -86758,7 +103279,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. * @example * ```js * // Before running the sample: @@ -86787,28 +103308,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.listWait( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.indexEndpoints.deployIndex({ + * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndex": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -86824,62 +103345,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + deployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + ): Promise>; + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait, - callback: BodyResponseCallback + deployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + deployIndex( + callback: BodyResponseCallback ): void; - listWait( + deployIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Deployindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; options = {}; } @@ -86892,31 +103408,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Finds the nearest neighbors of each vector within the request. * @example * ```js * // Before running the sample: @@ -86945,24 +103462,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.featureViews.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/featureViews/my-featureView/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.indexEndpoints.findNeighbors({ + * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedIndexId": "my_deployedIndexId", + * // "queries": [], + * // "returnFullDatapoint": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nearestNeighbors": [] * // } * } * @@ -86978,58 +103497,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + findNeighbors( + params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait, - callback: BodyResponseCallback + findNeighbors( + params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + findNeighbors( + callback: BodyResponseCallback ): void; - wait( + findNeighbors( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait; + {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; options = {}; } @@ -87042,81 +103565,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets an IndexEndpoint. * @example * ```js * // Before running the sample: @@ -87145,15 +103621,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.indexEndpoints.get({ + * // Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -87168,54 +103660,61 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; options = {}; } @@ -87229,7 +103728,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -87240,17 +103739,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Lists IndexEndpoints in a Location. * @example * ```js * // Before running the sample: @@ -87279,20 +103780,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.indexEndpoints.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "indexEndpoints": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -87308,58 +103813,61 @@ export namespace aiplatform_v1 { * @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$Featureonlinestores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Indexendpoints$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexendpoints$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; options = {}; } @@ -87372,29 +103880,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Update an existing DeployedIndex under an IndexEndpoint. * @example * ```js * // Before running the sample: @@ -87424,27 +103937,44 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.listWait( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * await aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex({ + * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * // Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "automaticResources": {}, + * // "createTime": "my_createTime", + * // "dedicatedResources": {}, + * // "deployedIndexAuthConfig": {}, + * // "deploymentGroup": "my_deploymentGroup", + * // "deploymentTier": "my_deploymentTier", + * // "displayName": "my_displayName", + * // "enableAccessLogging": false, + * // "enableDatapointUpsertLogging": false, + * // "id": "my_id", + * // "index": "my_index", + * // "indexSyncTime": "my_indexSyncTime", + * // "privateEndpoints": {}, + * // "pscAutomationConfigs": [], + * // "reservedIpRanges": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -87460,62 +103990,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions ): Promise>; - listWait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + mutateDeployedIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + ): Promise>; + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listWait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait, - callback: BodyResponseCallback + mutateDeployedIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + callback: BodyResponseCallback ): void; - listWait( - callback: BodyResponseCallback + mutateDeployedIndex( + callback: BodyResponseCallback ): void; - listWait( + mutateDeployedIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait; + {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; options = {}; } @@ -87528,31 +104053,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates an IndexEndpoint. * @example * ```js * // Before running the sample: @@ -87581,22 +104107,55 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featureOnlineStores.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featureOnlineStores/my-featureOnlineStore/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.indexEndpoints.patch({ + * // Output only. The resource name of the IndexEndpoint. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "enablePrivateServiceConnect": false, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "privateServiceConnectConfig": {}, + * // "publicEndpointDomainName": "my_publicEndpointDomainName", + * // "publicEndpointEnabled": false, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -87611,59 +104170,62 @@ export namespace aiplatform_v1 { * @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. - */ - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + */ + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; options = {}; } @@ -87676,8 +104238,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -87688,75 +104250,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Listwait 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featureonlinestores$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featurestores { - context: APIRequestContext; - entityTypes: Resource$Projects$Locations$Featurestores$Entitytypes; - operations: Resource$Projects$Locations$Featurestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.entityTypes = - new Resource$Projects$Locations$Featurestores$Entitytypes(this.context); - this.operations = - new Resource$Projects$Locations$Featurestores$Operations(this.context); - } /** - * Batch reads Feature values from a Featurestore. This API enables batch reading Feature values, where each read instance in the batch may read Feature values of entities from one or more EntityTypes. Point-in-time correctness is guaranteed for Feature values of each read instance as of each instance's read timestamp. + * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. * @example * ```js * // Before running the sample: @@ -87786,21 +104292,17 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.batchReadFeatureValues({ - * // Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * featurestore: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', + * await aiplatform.projects.locations.indexEndpoints.readIndexDatapoints({ + * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "bigqueryReadInstances": {}, - * // "csvReadInstances": {}, - * // "destination": {}, - * // "entityTypeSpecs": [], - * // "passThroughFields": [], - * // "startTime": "my_startTime" + * // "deployedIndexId": "my_deployedIndexId", + * // "ids": [] * // } * }, * }); @@ -87808,11 +104310,7 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "datapoints": [] * // } * } * @@ -87828,58 +104326,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: StreamMethodOptions ): Promise>; - batchReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + readIndexDatapoints( + params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options?: MethodOptions - ): Promise>; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues, - callback: BodyResponseCallback + readIndexDatapoints( + params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + callback: BodyResponseCallback ): void; - batchReadFeatureValues( - callback: BodyResponseCallback + readIndexDatapoints( + callback: BodyResponseCallback ): void; - batchReadFeatureValues( + readIndexDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; options = {}; } @@ -87892,31 +104394,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+featurestore}:batchReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['featurestore'], - pathParams: ['featurestore'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new Featurestore in a given project and location. + * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. * @example * ```js * // Before running the sample: @@ -87945,27 +104450,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.create({ - * // Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - * featurestoreId: 'placeholder-value', - * // Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.indexEndpoints.undeployIndex({ + * // Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * indexEndpoint: + * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "deployedIndexId": "my_deployedIndexId" * // } * }, * }); @@ -87993,36 +104487,35 @@ export namespace aiplatform_v1 { * @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$Featurestores$Create, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Create, + undeployIndex( + params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Create, + undeployIndex( + params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, callback: BodyResponseCallback ): void; - create( + undeployIndex( callback: BodyResponseCallback ): void; - create( + undeployIndex( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Create + | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88038,12 +104531,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Create; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Create; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; options = {}; } @@ -88056,7 +104550,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( /([^:]\/)\/+/g, '$1' ), @@ -88066,8 +104560,8 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['indexEndpoint'], + pathParams: ['indexEndpoint'], context: this.context, }; if (callback) { @@ -88079,9 +104573,136 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Create extends StandardParameters { /** - * Deletes a single Featurestore. The Featurestore must not contain any EntityTypes or `force` must be set to true for the request to succeed. + * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Delete extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Get extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + /** + * Optional. The update mask applies to the resource. The supported paths are `automatic_resources`, `dedicated_resources`, `enable_access_logging` and `deployed_index_auth_config`. When omitted, the service will perform a full update of all fields. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Patch extends StandardParameters { + /** + * Output only. The resource name of the IndexEndpoint. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints extends StandardParameters { + /** + * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex extends StandardParameters { + /** + * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + } + + export class Resource$Projects$Locations$Indexendpoints$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -88110,22 +104731,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.delete({ - * // If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) - * force: 'placeholder-value', - * // Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * }); + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -88140,57 +104754,54 @@ export namespace aiplatform_v1 { * @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$Featurestores$Delete, + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Delete; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Delete; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; options = {}; } @@ -88203,8 +104814,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -88215,17 +104826,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Featurestore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -88254,26 +104865,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.get({ - * // Required. The name of the Featurestore resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * }); + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -88288,61 +104888,54 @@ export namespace aiplatform_v1 { * @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$Featurestores$Get, + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Get, + delete( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Get; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Get; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; options = {}; } @@ -88356,7 +104949,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -88367,19 +104960,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -88408,20 +104999,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.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/locations/my-location/featurestores/my-featurestore', - * }); + * const res = await aiplatform.projects.locations.indexEndpoints.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -88437,56 +105029,57 @@ export namespace aiplatform_v1 { * @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$Locations$Featurestores$Getiampolicy, + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Getiampolicy; + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; options = {}; } @@ -88499,32 +105092,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Featurestores in a given project and location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -88553,26 +105143,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.list({ - * // Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` - * orderBy: 'placeholder-value', - * // The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "featurestores": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -88589,60 +105179,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$List, + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$List, + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexendpoints$Operations$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$Featurestores$List; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$List; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; options = {}; } @@ -88655,7 +105246,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/featurestores').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -88665,24 +105256,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Featurestore. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -88711,30 +105302,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.patch({ - * // Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "onlineServingConfig": {}, - * // "onlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.indexEndpoints.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -88759,36 +105333,35 @@ export namespace aiplatform_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$Featurestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Patch, + wait( + params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Patch, + wait( + params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Patch + | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -88804,12 +105377,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Patch; + {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Featurestores$Patch; + params = + {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; options = {}; } @@ -88822,8 +105396,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -88842,163 +105416,71 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel extends StandardParameters { /** - * Searches Features matching a query in a given project. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.featurestores.searchFeatures({ - * // Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` - * location: 'projects/my-project/locations/my-location', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. - * query: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "features": [], - * // "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. + * The name of the operation resource to be cancelled. */ - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - options: StreamMethodOptions - ): Promise>; - searchFeatures( - params?: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - searchFeatures( - params: Params$Resource$Projects$Locations$Featurestores$Searchfeatures, - callback: BodyResponseCallback - ): void; - searchFeatures( - callback: BodyResponseCallback - ): void; - searchFeatures( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Searchfeatures - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Searchfeatures; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+location}/featurestores:searchFeatures' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['location'], - pathParams: ['location'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Projects$Locations$Indexes { + context: APIRequestContext; + operations: Resource$Projects$Locations$Indexes$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Indexes$Operations( + this.context + ); } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Creates an Index. * @example * ```js * // Before running the sample: @@ -89027,16 +105509,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.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/locations/my-location/featurestores/my-featurestore', + * const res = await aiplatform.projects.locations.indexes.create({ + * // Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "policy": {} + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, + * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -89044,9 +105539,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -89062,56 +105559,56 @@ export namespace aiplatform_v1 { * @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$Locations$Featurestores$Setiampolicy, + create( + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + create( + params?: Params$Resource$Projects$Locations$Indexes$Create, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Indexes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Indexes$Create, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - setIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Indexes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Indexes$Create; options = {}; } @@ -89124,7 +105621,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/indexes').replace( /([^:]\/)\/+/g, '$1' ), @@ -89134,22 +105631,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. * @example * ```js * // Before running the sample: @@ -89178,19 +105675,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * }); + * const res = await aiplatform.projects.locations.indexes.delete({ + * // Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -89206,62 +105703,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Indexes$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexes$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - testIamPermissions( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Indexes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Indexes$Delete; options = {}; } @@ -89274,184 +105765,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Batchreadfeaturevalues extends StandardParameters { - /** - * Required. The resource name of the Featurestore from which to query Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - featurestore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Create extends StandardParameters { - /** - * Required. The ID to use for this Featurestore, which will become the final component of the Featurestore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. - */ - featurestoreId?: string; - /** - * Required. The resource name of the Location to create Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Delete extends StandardParameters { - /** - * If set to true, any EntityTypes and Features for this Featurestore will also be deleted. (Otherwise, the request will only work if the Featurestore has no EntityTypes.) - */ - force?: boolean; - /** - * Required. The name of the Featurestore to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Get extends StandardParameters { - /** - * Required. The name of the Featurestore resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$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$Locations$Featurestores$List extends StandardParameters { - /** - * Lists the featurestores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `online_serving_config.fixed_node_count`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` Featurestores created or updated after 2020-01-01. * `labels.env = "prod"` Featurestores with label "env" set to "prod". - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` * `online_serving_config.fixed_node_count` - */ - orderBy?: string; - /** - * The maximum number of Featurestores to return. The service may return fewer than this value. If unspecified, at most 100 Featurestores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListFeaturestores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeaturestores must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list Featurestores. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Patch extends StandardParameters { - /** - * Output only. Name of the Featurestore. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the Featurestore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `online_serving_config.fixed_node_count` * `online_serving_config.scaling` * `online_storage_ttl_days` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Featurestore; - } - export interface Params$Resource$Projects$Locations$Featurestores$Searchfeatures extends StandardParameters { - /** - * Required. The resource name of the Location to search Features. Format: `projects/{project\}/locations/{location\}` - */ - location?: string; - /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 100 Features will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.SearchFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.SearchFeatures, except `page_size`, must match the call that provided the page token. - */ - pageToken?: string; - /** - * Query string that is a conjunction of field-restricted queries and/or field-restricted filters. Field-restricted queries and filters can be combined using `AND` to form a conjunction. A field query is in the form FIELD:QUERY. This implicitly checks if QUERY exists as a substring within Feature's FIELD. The QUERY and the FIELD are converted to a sequence of words (i.e. tokens) for comparison. This is done by: * Removing leading/trailing whitespace and tokenizing the search value. Characters that are not one of alphanumeric `[a-zA-Z0-9]`, underscore `_`, or asterisk `*` are treated as delimiters for tokens. `*` is treated as a wildcard that matches characters within a token. * Ignoring case. * Prepending an asterisk to the first and appending an asterisk to the last token in QUERY. A QUERY must be either a singular token or a phrase. A phrase is one or multiple words enclosed in double quotation marks ("). With phrases, the order of the words is important. Words in the phrase must be matching in order and consecutively. Supported FIELDs for field-restricted queries: * `feature_id` * `description` * `entity_type_id` Examples: * `feature_id: foo` --\> Matches a Feature with ID containing the substring `foo` (eg. `foo`, `foofeature`, `barfoo`). * `feature_id: foo*feature` --\> Matches a Feature with ID containing the substring `foo*feature` (eg. `foobarfeature`). * `feature_id: foo AND description: bar` --\> Matches a Feature with ID containing the substring `foo` and description containing the substring `bar`. Besides field queries, the following exact-match filters are supported. The exact-match filters do not support wildcards. Unlike field-restricted queries, exact-match filters are case-sensitive. * `feature_id`: Supports = comparisons. * `description`: Supports = comparisons. Multi-token filters should be enclosed in quotes. * `entity_type_id`: Supports = comparisons. * `value_type`: Supports = and != comparisons. * `labels`: Supports key-value equality as well as key presence. * `featurestore_id`: Supports = comparisons. Examples: * `description = "foo bar"` --\> Any Feature with description exactly equal to `foo bar` * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with `env` as the key. - */ - query?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Featurestores$Entitytypes { - context: APIRequestContext; - features: Resource$Projects$Locations$Featurestores$Entitytypes$Features; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.features = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Operations( - this.context - ); - } /** - * Creates a new EntityType in a given Featurestore. + * Gets an Index. * @example * ```js * // Before running the sample: @@ -89480,40 +105816,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.create({ - * // Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. - * entityTypeId: 'placeholder-value', - * // Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.indexes.get({ + * // Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", * // "name": "my_name", - * // "response": {} + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -89529,58 +105854,57 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Create, + get( + params: Params$Resource$Projects$Locations$Indexes$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + get( + params?: Params$Resource$Projects$Locations$Indexes$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, + get( + params: Params$Resource$Projects$Locations$Indexes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexes$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + {}) as Params$Resource$Projects$Locations$Indexes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create; + params = {} as Params$Resource$Projects$Locations$Indexes$Get; options = {}; } @@ -89593,32 +105917,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single EntityType. The EntityType must not have any Features or `force` must be set to true for the request to succeed. + * Lists Indexes in a Location. * @example * ```js * // Before running the sample: @@ -89647,22 +105970,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.delete({ - * // If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) - * force: 'placeholder-value', - * // Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * }); + * const res = await aiplatform.projects.locations.indexes.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "indexes": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -89678,58 +106003,61 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Delete, + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + list( + params?: Params$Resource$Projects$Locations$Indexes$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, + list( + params: Params$Resource$Projects$Locations$Indexes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexes$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + {}) as Params$Resource$Projects$Locations$Indexes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete; + params = {} as Params$Resource$Projects$Locations$Indexes$List; options = {}; } @@ -89742,29 +106070,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/indexes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Delete Feature values from Featurestore. The progress of the deletion is tracked by the returned operation. The deleted feature values are guaranteed to be invisible to subsequent read operations after the operation is marked as successfully done. If a delete feature values operation fails, the feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same delete request again and wait till the new operation returned is marked as successfully done. + * Updates an Index. * @example * ```js * // Before running the sample: @@ -89793,23 +106126,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.deleteFeatureValues( - * { - * // Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.indexes.patch({ + * // Output only. The resource name of the Index. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * // The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "selectEntity": {}, - * // "selectTimeRangeAndFeature": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "deployedIndexes": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "indexStats": {}, + * // "indexUpdateMethod": "my_indexUpdateMethod", + * // "labels": {}, + * // "metadata": {}, + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "name": "my_name", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -89834,36 +106178,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions ): Promise>; - deleteFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + patch( + params?: Params$Resource$Projects$Locations$Indexes$Patch, options?: MethodOptions ): Promise>; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues, + patch( + params: Params$Resource$Projects$Locations$Indexes$Patch, callback: BodyResponseCallback ): void; - deleteFeatureValues( + patch( callback: BodyResponseCallback ): void; - deleteFeatureValues( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues + | Params$Resource$Projects$Locations$Indexes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -89879,13 +106222,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + {}) as Params$Resource$Projects$Locations$Indexes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues; + params = {} as Params$Resource$Projects$Locations$Indexes$Patch; options = {}; } @@ -89898,18 +106240,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:deleteFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -89923,7 +106262,7 @@ export namespace aiplatform_v1 { } /** - * Exports Feature values from all the entities of a target EntityType. + * Remove Datapoints from an Index. * @example * ```js * // Before running the sample: @@ -89952,36 +106291,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.exportFeatureValues( - * { - * // Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.indexes.removeDatapoints({ + * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * index: 'projects/my-project/locations/my-location/indexes/my-indexe', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "destination": {}, - * // "featureSelector": {}, - * // "fullExport": {}, - * // "settings": [], - * // "snapshotExport": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "datapointIds": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -89996,58 +106321,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions ): Promise>; - exportFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + removeDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options?: MethodOptions - ): Promise>; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + ): Promise< + GaxiosResponseWithHTTP2 + >; + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues, - callback: BodyResponseCallback + removeDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + callback: BodyResponseCallback ): void; - exportFeatureValues( - callback: BodyResponseCallback + removeDatapoints( + callback: BodyResponseCallback ): void; - exportFeatureValues( + removeDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Removedatapoints + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues; + {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; options = {}; } @@ -90060,7 +106389,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:exportFeatureValues').replace( + url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( /([^:]\/)\/+/g, '$1' ), @@ -90070,22 +106399,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single EntityType. + * Add/update Datapoints into an Index. * @example * ```js * // Before running the sample: @@ -90114,27 +106445,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.entityTypes.get( - * { - * // Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.indexes.upsertDatapoints({ + * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * index: 'projects/my-project/locations/my-location/indexes/my-indexe', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "datapoints": [], + * // "updateMask": "my_updateMask" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -90149,62 +106476,62 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Get, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + upsertDatapoints( + params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get, - callback: BodyResponseCallback + upsertDatapoints( + params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + upsertDatapoints( + callback: BodyResponseCallback ): void; - get( + upsertDatapoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints + | 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$Featurestores$Entitytypes$Get; + {}) as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get; + {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; options = {}; } @@ -90217,31 +106544,124 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['index'], + pathParams: ['index'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Indexes$Create extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Delete extends StandardParameters { + /** + * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Get extends StandardParameters { + /** + * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$List extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Patch extends StandardParameters { + /** + * Output only. The resource name of the Index. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Index; + } + export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; + } + export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints extends StandardParameters { + /** + * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; + } + + export class Resource$Projects$Locations$Indexes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -90270,22 +106690,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.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/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * }); + * const res = await aiplatform.projects.locations.indexes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -90300,56 +106712,54 @@ export namespace aiplatform_v1 { * @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$Locations$Featurestores$Entitytypes$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Getiampolicy; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; options = {}; } @@ -90362,32 +106772,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Imports Feature values into the Featurestore from a source storage. The progress of the import is tracked by the returned operation. The imported features are guaranteed to be visible to subsequent read operations after the operation is marked as successfully done. If an import operation fails, the Feature values returned from reads and exports may be inconsistent. If consistency is required, the caller must retry the same import request again and wait till the new operation returned is marked as successfully done. There are also scenarios where the caller can cause inconsistency. - Source data for import contains multiple distinct Feature values for the same entity ID and timestamp. - Source is modified during an import. This includes adding, updating, or removing source data and/or metadata. Examples of updating metadata include but are not limited to changing storage location, storage class, or retention policy. - Online serving cluster is under-provisioned. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -90398,59 +106805,32 @@ export namespace aiplatform_v1 { * // $ gcloud auth application-default login * // ``` * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const aiplatform = google.aiplatform('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 aiplatform.projects.locations.featurestores.entityTypes.importFeatureValues( - * { - * // Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "avroSource": {}, - * // "bigquerySource": {}, - * // "csvSource": {}, - * // "disableIngestionAnalysis": false, - * // "disableOnlineServing": false, - * // "entityIdField": "my_entityIdField", - * // "featureSpecs": [], - * // "featureTime": "my_featureTime", - * // "featureTimeField": "my_featureTimeField", - * // "workerCount": 0 - * // } - * }, - * }, - * ); + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const aiplatform = google.aiplatform('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 aiplatform.projects.locations.indexes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -90465,58 +106845,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions ): Promise>; - importFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + delete( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options?: MethodOptions - ): Promise>; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - importFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - importFeatureValues( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + callback: BodyResponseCallback ): void; - importFeatureValues( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Importfeaturevalues; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; options = {}; } @@ -90529,32 +106905,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:importFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists EntityTypes in a given Featurestore. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -90583,28 +106956,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.list({ - * // Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.indexes.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "entityTypes": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -90620,62 +106984,57 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$List, + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + get( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$List; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; options = {}; } @@ -90688,34 +107047,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entityTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single EntityType. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -90744,44 +107098,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.patch({ - * // Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.indexes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringConfig": {}, - * // "name": "my_name", - * // "offlineStorageTtlDays": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -90797,62 +107132,62 @@ export namespace aiplatform_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$Featurestores$Entitytypes$Patch, + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + list( + params?: Params$Resource$Projects$Locations$Indexes$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Indexes$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$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$Featurestores$Entitytypes$Patch; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch; + {} as Params$Resource$Projects$Locations$Indexes$Operations$List; options = {}; } @@ -90865,8 +107200,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -90877,19 +107215,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Reads Feature values of a specific entity of an EntityType. For reading feature values of multiple entities of an EntityType, please use StreamingReadFeatureValues. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -90918,29 +107256,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.readFeatureValues( - * { - * // Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entityId": "my_entityId", - * // "featureSelector": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.indexes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "entityView": {}, - * // "header": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -90956,62 +107286,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions ): Promise>; - readFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + wait( + params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + callback: BodyResponseCallback ): void; - readFeatureValues( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - readFeatureValues( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Indexes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues; + {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; options = {}; } @@ -91024,34 +107349,95 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:readFeatureValues').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Indexes$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Memorybanks { + context: APIRequestContext; + memories: Resource$Projects$Locations$Memorybanks$Memories; + operations: Resource$Projects$Locations$Memorybanks$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.memories = new Resource$Projects$Locations$Memorybanks$Memories( + this.context + ); + this.operations = new Resource$Projects$Locations$Memorybanks$Operations( + this.context + ); + } + + /** + * Ingests events for a Memory Bank. * @example * ```js * // Before running the sample: @@ -91080,27 +107466,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.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/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.memoryBanks.ingestEvents({ + * // Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "directContentsSource": {}, + * // "disableMemoryRevisions": false, + * // "forceFlush": false, + * // "generationTriggerConfig": {}, + * // "metadata": {}, + * // "metadataMergeStrategy": "my_metadataMergeStrategy", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "streamId": "my_streamId" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -91116,56 +107513,57 @@ export namespace aiplatform_v1 { * @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$Locations$Featurestores$Entitytypes$Setiampolicy, + ingestEvents( + params: Params$Resource$Projects$Locations$Memorybanks$Ingestevents, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + ingestEvents( + params?: Params$Resource$Projects$Locations$Memorybanks$Ingestevents, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, + ): Promise>; + ingestEvents( + params: Params$Resource$Projects$Locations$Memorybanks$Ingestevents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ingestEvents( + params: Params$Resource$Projects$Locations$Memorybanks$Ingestevents, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy, - callback: BodyResponseCallback + ingestEvents( + params: Params$Resource$Projects$Locations$Memorybanks$Ingestevents, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + ingestEvents( + callback: BodyResponseCallback ): void; - setIamPolicy( + ingestEvents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Ingestevents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Memorybanks$Ingestevents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Memorybanks$Ingestevents; options = {}; } @@ -91178,7 +107576,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}:ingestEvents').replace( /([^:]\/)\/+/g, '$1' ), @@ -91188,22 +107586,51 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Memorybanks$Ingestevents extends StandardParameters { /** - * Reads Feature values for multiple entities. Depending on their size, data for different entities may be broken up across multiple responses. + * Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IngestEventsRequest; + } + + export class Resource$Projects$Locations$Memorybanks$Memories { + context: APIRequestContext; + operations: Resource$Projects$Locations$Memorybanks$Memories$Operations; + revisions: Resource$Projects$Locations$Memorybanks$Memories$Revisions; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Memorybanks$Memories$Operations( + this.context + ); + this.revisions = + new Resource$Projects$Locations$Memorybanks$Memories$Revisions( + this.context + ); + } + + /** + * Create a Memory. * @example * ```js * // Before running the sample: @@ -91232,29 +107659,44 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.streamingReadFeatureValues( - * { - * // Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.memoryBanks.memories.create({ + * // Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. + * memoryId: 'placeholder-value', + * // Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entityIds": [], - * // "featureSelector": {} - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", + * // "metadata": {}, + * // "name": "my_name", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "entityView": {}, - * // "header": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -91270,62 +107712,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + create( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Create, options: StreamMethodOptions ): Promise>; - streamingReadFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + create( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, + create( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Create, + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - streamingReadFeatureValues( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Create; options = {}; } @@ -91338,33 +107775,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+entityType}:streamingReadFeatureValues' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/memories').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Delete a Memory. * @example * ```js * // Before running the sample: @@ -91393,21 +107829,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.testIamPermissions( - * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.memories.delete({ + * // Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', + * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -91423,62 +107857,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - testIamPermissions( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Delete; options = {}; } @@ -91491,34 +107920,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Writes Feature values of one or more entities of an EntityType. The Feature values are merged into existing entities if any. The Feature values to be written must have timestamp within the online storage retention. + * Generate memories. * @example * ```js * // Before running the sample: @@ -91547,26 +107971,42 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.writeFeatureValues( - * { - * // Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - * entityType: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', + * const res = await aiplatform.projects.locations.memoryBanks.memories.generate( + * { + * // Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "payloads": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowedTopics": [], + * // "directContentsSource": {}, + * // "directMemoriesSource": {}, + * // "disableConsolidation": false, + * // "disableMemoryRevisions": false, + * // "metadata": {}, + * // "metadataMergeStrategy": "my_metadataMergeStrategy", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "vertexSessionSource": {} + * // } * }, - * ); + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -91581,62 +108021,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + generate( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Generate, options: StreamMethodOptions ): Promise>; - writeFeatureValues( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + generate( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Generate, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + ): Promise>; + generate( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Generate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, + generate( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Generate, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - writeFeatureValues( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues, - callback: BodyResponseCallback + generate( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Generate, + callback: BodyResponseCallback ): void; - writeFeatureValues( - callback: BodyResponseCallback + generate( + callback: BodyResponseCallback ): void; - writeFeatureValues( + generate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Generate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Generate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Generate; options = {}; } @@ -91649,7 +108084,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+entityType}:writeFeatureValues').replace( + url: (rootUrl + '/v1/{+parent}/memories:generate').replace( /([^:]\/)\/+/g, '$1' ), @@ -91659,206 +108094,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['entityType'], - pathParams: ['entityType'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Create extends StandardParameters { - /** - * Required. The ID to use for the EntityType, which will become the final component of the EntityType's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a featurestore. - */ - entityTypeId?: string; - /** - * Required. The resource name of the Featurestore to create EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Delete extends StandardParameters { - /** - * If set to true, any Features for this EntityType will also be deleted. (Otherwise, the request will only work if the EntityType has no Features.) - */ - force?: boolean; - /** - * Required. The name of the EntityType to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Deletefeaturevalues extends StandardParameters { - /** - * Required. The resource name of the EntityType grouping the Features for which values are being deleted from. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1DeleteFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Exportfeaturevalues extends StandardParameters { - /** - * Required. The resource name of the EntityType from which to export Feature values. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Get extends StandardParameters { - /** - * Required. The name of the EntityType resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$Locations$Featurestores$Entitytypes$Importfeaturevalues extends StandardParameters { - /** - * Required. The resource name of the EntityType grouping the Features for which values are being imported. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}` - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$List extends StandardParameters { - /** - * Lists the EntityTypes that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> EntityTypes having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any EntityType which has a label with 'env' as the key. - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `entity_type_id` * `create_time` * `update_time` - */ - orderBy?: string; - /** - * The maximum number of EntityTypes to return. The service may return fewer than this value. If unspecified, at most 1000 EntityTypes will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous FeaturestoreService.ListEntityTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListEntityTypes must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Featurestore to list EntityTypes. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Patch extends StandardParameters { - /** - * Immutable. Name of the EntityType. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` The last part entity_type is assigned by the client. The entity_type can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z and underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given a featurestore. - */ - name?: string; - /** - * Field mask is used to specify the fields to be overwritten in the EntityType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `monitoring_config.snapshot_analysis.disabled` * `monitoring_config.snapshot_analysis.monitoring_interval_days` * `monitoring_config.snapshot_analysis.staleness_days` * `monitoring_config.import_features_analysis.state` * `monitoring_config.import_features_analysis.anomaly_detection_baseline` * `monitoring_config.numerical_threshold_config.value` * `monitoring_config.categorical_threshold_config.value` * `offline_storage_ttl_days` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EntityType; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Readfeaturevalues extends StandardParameters { - /** - * Required. The resource name of the EntityType for the entity being read. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Streamingreadfeaturevalues extends StandardParameters { - /** - * Required. The resource name of the entities' type. Value format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingReadFeatureValuesRequest; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Writefeaturevalues extends StandardParameters { - /** - * Required. The resource name of the EntityType for the entities being written. Value format: `projects/{project\}/locations/{location\}/featurestores/ {featurestore\}/entityTypes/{entityType\}`. For example, for a machine learning model predicting user clicks on a website, an EntityType ID could be `user`. - */ - entityType?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteFeatureValuesRequest; - } - - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations( - this.context + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a batch of Features in a given EntityType. + * Get a Memory. * @example * ```js * // Before running the sample: @@ -91887,31 +108138,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.batchCreate( - * { - * // Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.memories.get({ + * // Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" * // } * } * @@ -91927,58 +108176,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Get, options: StreamMethodOptions ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + get( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Get, options?: MethodOptions - ): Promise>; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Get, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Get; options = {}; } @@ -91991,32 +108240,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a new Feature in a given EntityType. + * List Memories. * @example * ```js * // Before running the sample: @@ -92045,43 +108293,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.create( - * { - * // Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. - * featureId: 'placeholder-value', - * // Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.memories.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) + * filter: 'placeholder-value', + * // Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "memories": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -92097,58 +108327,62 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Features$Create, + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + list( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$List; options = {}; } @@ -92161,11 +108395,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+parent}/memories').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -92176,17 +108410,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a single Feature. + * Update a Memory. * @example * ```js * // Before running the sample: @@ -92215,13 +108451,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.delete( - * { - * // Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.memories.patch({ + * // Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', + * // Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", + * // "metadata": {}, + * // "name": "my_name", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -92246,36 +108503,35 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Features$Delete, + patch( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + patch( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Patch, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + patch( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + patch( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Patch, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete, + patch( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Patch, callback: BodyResponseCallback ): void; - delete( + patch( callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete + | Params$Resource$Projects$Locations$Memorybanks$Memories$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -92291,13 +108547,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Patch; options = {}; } @@ -92311,7 +108567,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -92332,7 +108588,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of a single Feature. + * Purge memories. * @example * ```js * // Before running the sample: @@ -92361,26 +108617,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.get({ - * // Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * }); + * const res = await aiplatform.projects.locations.memoryBanks.memories.purge({ + * // Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "filterGroups": [], + * // "force": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" + * // "response": {} * // } * } * @@ -92396,58 +108656,57 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Features$Get, + purge( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Purge, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + purge( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Purge, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, + purge( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Purge, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Purge, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Purge; options = {}; } @@ -92460,31 +108719,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/memories:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Features in a given EntityType. + * Retrieve memories. * @example * ```js * // Before running the sample: @@ -92513,32 +108773,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.list( - * { - * // Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. - * filter: 'placeholder-value', - * // Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - * latestStatsCount: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` - * parent: - * 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.memoryBanks.memories.retrieve( + * { + * // Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "filterGroups": [], + * // "memoryTypes": [], + * // "scope": {}, + * // "similaritySearchParams": {}, + * // "simpleRetrievalParams": {} + * // } * }, - * ); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "features": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "retrievedMemories": [] * // } * } * @@ -92554,62 +108814,62 @@ export namespace aiplatform_v1 { * @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$Featurestores$Entitytypes$Features$List, + retrieve( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + retrieve( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + retrieve( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, + retrieve( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List, - callback: BodyResponseCallback + retrieve( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + retrieve( + callback: BodyResponseCallback ): void; - list( + retrieve( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve + | 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$Featurestores$Entitytypes$Features$List; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve; options = {}; } @@ -92622,11 +108882,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/features').replace( + url: (rootUrl + '/v1/{+parent}/memories:retrieve').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -92637,19 +108897,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the parameters of a single Feature. + * Rollback Memory to a specific revision. * @example * ```js * // Before running the sample: @@ -92678,48 +108938,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.patch( - * { - * // Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * // Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.memoryBanks.memories.rollback( + * { + * // Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], - * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "targetRevisionId": "my_targetRevisionId" + * // } * }, - * ); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMonitoring": false, - * // "etag": "my_etag", - * // "labels": {}, - * // "monitoringStatsAnomalies": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pointOfContact": "my_pointOfContact", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType", - * // "versionColumnName": "my_versionColumnName" + * // "response": {} * // } * } * @@ -92735,58 +108976,57 @@ export namespace aiplatform_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$Featurestores$Entitytypes$Features$Patch, + rollback( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + rollback( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + ): Promise>; + rollback( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, + rollback( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch, - callback: BodyResponseCallback + rollback( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + rollback( + callback: BodyResponseCallback ): void; - patch( + rollback( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback; options = {}; } @@ -92799,8 +109039,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:rollback').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -92811,103 +109054,126 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Create extends StandardParameters { /** - * Required. The resource name of the EntityType/FeatureGroup to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. + */ + memoryId?: string; + /** + * Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Memory; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Delete extends StandardParameters { /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + * Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ - featureId?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Generate extends StandardParameters { /** - * Required. The resource name of the EntityType or FeatureGroup to create a Feature. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete extends StandardParameters { - /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1GenerateMemoriesRequest; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Get extends StandardParameters { /** - * Required. The name of the Feature resource. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$List extends StandardParameters { /** - * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) */ filter?: string; /** - * Only applicable for Vertex AI Feature Store (Legacy). If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. - */ - latestStatsCount?: number; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + * Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` */ orderBy?: string; /** - * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + * Optional. The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous FeaturestoreService.ListFeatures call or FeatureRegistryService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures or FeatureRegistryService.ListFeatures must match the call that provided the page token. + * Optional. The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format for entity_type as parent: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` Format for feature_group as parent: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + * Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Patch extends StandardParameters { /** - * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + * Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) + * Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Feature; + requestBody?: Schema$GoogleCloudAiplatformV1Memory; } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Purge extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; - export class Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeMemoriesRequest; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Retrieve extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RetrieveMemoriesRequest; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Rollback extends StandardParameters { + /** + * Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RollbackMemoryRequest; + } + + export class Resource$Projects$Locations$Memorybanks$Memories$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -92944,12 +109210,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.memoryBanks.memories.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -92969,31 +109233,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel + | Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93009,13 +109273,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Cancel; options = {}; } @@ -93080,12 +109344,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.memoryBanks.memories.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -93105,31 +109367,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete + | Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93145,13 +109407,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete; options = {}; } @@ -93216,12 +109478,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.memoryBanks.memories.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -93247,27 +109507,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -93275,7 +109534,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get + | Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93291,13 +109550,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get; options = {}; } @@ -93362,20 +109621,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.memoryBanks.memories.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -93399,29 +109656,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List, callback: BodyResponseCallback ): void; list( @@ -93429,7 +109686,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List + | Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93447,13 +109704,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$List; options = {}; } @@ -93523,23 +109780,378 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.features.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/features/my-feature/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.memoryBanks.memories.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * 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. + */ + wait( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Memorybanks$Memories$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Memorybanks$Memories$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get a Memory Revision. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.memoryBanks.memories.revisions.get({ + * // Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie/revisions/my-revision', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "expireTime": "my_expireTime", + * // "extractedMemories": [], + * // "fact": "my_fact", + * // "labels": {}, + * // "name": "my_name", + * // "structuredData": {} + * // } + * } + * + * 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$Memorybanks$Memories$Revisions$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * List Memory Revisions for a Memory. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.memoryBanks.memories.revisions.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * parent: + * 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/memories/my-memorie', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "memoryRevisions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -93555,58 +110167,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait; + {} as Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List; options = {}; } @@ -93619,80 +110235,59 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/revisions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$Get extends StandardParameters { /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. + * Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Memories$Revisions$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` */ filter?: string; /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ - timeout?: string; + parent?: string; } - export class Resource$Projects$Locations$Featurestores$Entitytypes$Operations { + export class Resource$Projects$Locations$Memorybanks$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -93728,13 +110323,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -93754,31 +110348,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel + | Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93794,13 +110388,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel; options = {}; } @@ -93864,13 +110458,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -93890,31 +110483,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Memorybanks$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete + | Params$Resource$Projects$Locations$Memorybanks$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -93930,13 +110523,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Memorybanks$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Memorybanks$Operations$Delete; options = {}; } @@ -94000,13 +110593,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -94032,27 +110622,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params?: Params$Resource$Projects$Locations$Memorybanks$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -94060,7 +110649,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get + | Params$Resource$Projects$Locations$Memorybanks$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94076,13 +110665,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Memorybanks$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get; + {} as Params$Resource$Projects$Locations$Memorybanks$Operations$Get; options = {}; } @@ -94146,21 +110735,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -94184,29 +110770,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params?: Params$Resource$Projects$Locations$Memorybanks$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$List, callback: BodyResponseCallback ): void; list( @@ -94214,7 +110800,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List + | Params$Resource$Projects$Locations$Memorybanks$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94232,13 +110818,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {}) as Params$Resource$Projects$Locations$Memorybanks$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List; + {} as Params$Resource$Projects$Locations$Memorybanks$Operations$List; options = {}; } @@ -94307,15 +110893,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.entityTypes.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/entityTypes/my-entityType/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.memoryBanks.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/memoryBanks/my-memoryBank/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -94341,27 +110924,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Memorybanks$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait, + params: Params$Resource$Projects$Locations$Memorybanks$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -94369,7 +110951,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait + | Params$Resource$Projects$Locations$Memorybanks$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -94385,13 +110967,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Memorybanks$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Memorybanks$Operations$Wait; options = {}; } @@ -94426,25 +111008,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -94466,7 +111048,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Memorybanks$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -94477,14 +111059,193 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Featurestores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Projects$Locations$Metadatastores { + context: APIRequestContext; + artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; + contexts: Resource$Projects$Locations$Metadatastores$Contexts; + executions: Resource$Projects$Locations$Metadatastores$Executions; + metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; + operations: Resource$Projects$Locations$Metadatastores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( + this.context + ); + this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( + this.context + ); + this.executions = + new Resource$Projects$Locations$Metadatastores$Executions(this.context); + this.metadataSchemas = + new Resource$Projects$Locations$Metadatastores$Metadataschemas( + this.context + ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Operations(this.context); + } + + /** + * Initializes a MetadataStore, including allocation of resources. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.metadataStores.create({ + * // The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + * metadataStoreId: 'placeholder-value', + * // Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataplexConfig": {}, + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "state": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/metadataStores').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); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). * @example * ```js * // Before running the sample: @@ -94513,15 +111274,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.metadataStores.delete({ + * // Deprecated: Field is no longer supported. + * force: 'placeholder-value', + * // Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -94536,54 +111304,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; options = {}; } @@ -94596,8 +111366,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -94608,17 +111378,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Retrieves a specific MetadataStore. * @example * ```js * // Before running the sample: @@ -94647,15 +111417,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.featurestores.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.metadataStores.get({ + * // Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "dataplexConfig": {}, + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "name": "my_name", + * // "state": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -94670,54 +111447,61 @@ export namespace aiplatform_v1 { * @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$Featurestores$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; options = {}; } @@ -94731,7 +111515,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -94742,17 +111526,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Lists MetadataStores for a Location. * @example * ```js * // Before running the sample: @@ -94781,19 +111567,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', + * const res = await aiplatform.projects.locations.metadataStores.list({ + * // The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "metadataStores": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -94809,58 +111596,61 @@ export namespace aiplatform_v1 { * @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$Featurestores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Metadatastores$List; options = {}; } @@ -94873,29 +111663,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Metadatastores$Create extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + */ + metadataStoreId?: string; + /** + * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Delete extends StandardParameters { + /** + * Deprecated: Field is no longer supported. + */ + force?: boolean; + /** + * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Get extends StandardParameters { + /** + * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$List extends StandardParameters { + /** + * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + */ + pageToken?: string; + /** + * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Metadatastores$Artifacts { + context: APIRequestContext; + operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( + this.context + ); + } + + /** + * Creates an Artifact associated with a MetadataStore. * @example * ```js * // Before running the sample: @@ -94924,27 +111777,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.create({ + * // The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) + * artifactId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" * // } * } * @@ -94960,62 +111835,58 @@ export namespace aiplatform_v1 { * @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$Featurestores$Operations$List, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Featurestores$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; options = {}; } @@ -95028,34 +111899,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, 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 ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes an Artifact. * @example * ```js * // Before running the sample: @@ -95084,14 +111955,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.featurestores.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/featurestores/my-featurestore/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.delete({ + * // Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * }); * console.log(res.data); * * // Example response @@ -95116,36 +111986,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featurestores$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, callback: BodyResponseCallback ): void; - wait( + delete( callback: BodyResponseCallback ): void; - wait( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featurestores$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -95161,13 +112030,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featurestores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; options = {}; } @@ -95180,8 +112049,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -95200,72 +112069,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featurestores$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Featurestores$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Hyperparametertuningjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Hyperparametertuningjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Hyperparametertuningjobs$Operations( - this.context - ); - } /** - * Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on the HyperparameterTuningJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetHyperparameterTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the HyperparameterTuningJob is not deleted; instead it becomes a job with a HyperparameterTuningJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is set to `CANCELLED`. + * Retrieves a specific Artifact. * @example * ```js * // Before running the sample: @@ -95294,21 +112100,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.cancel({ - * // Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await aiplatform.projects.locations.metadataStores.artifacts.get({ + * // Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } * } * * main().catch(e => { @@ -95323,54 +112135,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; options = {}; } @@ -95383,8 +112199,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -95395,17 +112211,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a HyperparameterTuningJob + * Lists Artifacts in the MetadataStore. * @example * ```js * // Before running the sample: @@ -95434,58 +112252,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.create({ - * // Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, - * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.metadataStores.artifacts.list( + * { + * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, - * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" + * // "artifacts": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -95501,62 +112288,62 @@ export namespace aiplatform_v1 { * @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$Hyperparametertuningjobs$Create, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$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$Hyperparametertuningjobs$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; options = {}; } @@ -95569,11 +112356,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( + url: (rootUrl + '/v1/{+parent}/artifacts').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -95584,19 +112371,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a HyperparameterTuningJob. + * Updates a stored Artifact. * @example * ```js * // Before running the sample: @@ -95626,19 +112413,49 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.delete({ - * // Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * await aiplatform.projects.locations.metadataStores.artifacts.patch({ + * // If set to true, and the Artifact is not found, a new Artifact is created. + * allowMissing: 'placeholder-value', + * // Output only. The resource name of the Artifact. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime", + * // "uri": "my_uri" * // } * } * @@ -95654,58 +112471,58 @@ export namespace aiplatform_v1 { * @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$Hyperparametertuningjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; options = {}; } @@ -95719,7 +112536,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -95730,17 +112547,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a HyperparameterTuningJob + * Purges Artifacts. * @example * ```js * // Before running the sample: @@ -95769,32 +112588,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.get({ - * // Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.purge({ + * // Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", + * // "done": false, * // "error": {}, - * // "labels": {}, - * // "maxFailedTrialCount": 0, - * // "maxTrialCount": 0, + * // "metadata": {}, * // "name": "my_name", - * // "parallelTrialCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "studySpec": {}, - * // "trialJobSpec": {}, - * // "trials": [], - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -95810,62 +112627,57 @@ export namespace aiplatform_v1 { * @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$Hyperparametertuningjobs$Get, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - get( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; options = {}; } @@ -95878,31 +112690,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists HyperparameterTuningJobs in a Location. + * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. * @example * ```js * // Before running the sample: @@ -95931,26 +112744,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.hyperparameterTuningJobs.list( - * { - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph( + * { + * // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * artifact: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', + * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + * maxHops: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "hyperparameterTuningJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "artifacts": [], + * // "events": [], + * // "executions": [] * // } * } * @@ -95966,62 +112778,62 @@ export namespace aiplatform_v1 { * @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$Hyperparametertuningjobs$List, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + queryArtifactLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$List, - callback: BodyResponseCallback + queryArtifactLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + queryArtifactLineageSubgraph( + callback: BodyResponseCallback ): void; - list( + queryArtifactLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph + | 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$Hyperparametertuningjobs$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; options = {}; } @@ -96034,91 +112846,131 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/hyperparameterTuningJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['artifact'], + pathParams: ['artifact'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Cancel extends StandardParameters { - /** - * Required. The name of the HyperparameterTuningJob to cancel. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` - */ - name?: string; - + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create extends StandardParameters { /** - * Request body metadata + * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelHyperparameterTuningJobRequest; - } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Create extends StandardParameters { + artifactId?: string; /** - * Required. The resource name of the Location to create the HyperparameterTuningJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1HyperparameterTuningJob; + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get extends StandardParameters { /** - * Required. The name of the HyperparameterTuningJob resource. Format: `projects/{project\}/locations/{location\}/hyperparameterTuningJobs/{hyperparameter_tuning_job\}` + * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** - * The standard list page size. + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListHyperparameterTuningJobsResponse.next_page_token of the previous JobService.ListHyperparameterTuningJobs call. + * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The resource name of the Location to list the HyperparameterTuningJobs from. Format: `projects/{project\}/locations/{location\}` + * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch extends StandardParameters { /** - * Mask specifying which fields to read. + * If set to true, and the Artifact is not found, a new Artifact is created. */ - readMask?: string; + allowMissing?: boolean; + /** + * Output only. The resource name of the Artifact. + */ + name?: string; + /** + * Optional. A FieldMask indicating which fields should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Artifact; } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge extends StandardParameters { + /** + * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; - export class Resource$Projects$Locations$Hyperparametertuningjobs$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph extends StandardParameters { + /** + * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + */ + artifact?: string; + /** + * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + */ + filter?: string; + /** + * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + */ + maxHops?: number; + } + + export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -96155,10 +113007,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.cancel( + * await aiplatform.projects.locations.metadataStores.artifacts.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }, * ); * console.log(res.data); @@ -96180,31 +113032,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96220,13 +113072,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; options = {}; } @@ -96291,10 +113143,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.delete( + * await aiplatform.projects.locations.metadataStores.artifacts.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }, * ); * console.log(res.data); @@ -96316,31 +113168,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96356,13 +113208,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; options = {}; } @@ -96427,10 +113279,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.get( + * await aiplatform.projects.locations.metadataStores.artifacts.operations.get( * { * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * }, * ); * console.log(res.data); @@ -96458,27 +113310,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -96486,7 +113337,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96502,13 +113353,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; options = {}; } @@ -96573,12 +113424,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.list( + * await aiplatform.projects.locations.metadataStores.artifacts.operations.list( * { * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob', + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -96610,29 +113461,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -96640,7 +113491,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96658,13 +113509,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; options = {}; } @@ -96734,10 +113585,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.hyperparameterTuningJobs.operations.wait( + * await aiplatform.projects.locations.metadataStores.artifacts.operations.wait( * { * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/hyperparameterTuningJobs/my-hyperparameterTuningJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }, @@ -96767,27 +113618,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -96795,7 +113645,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -96811,13 +113661,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; options = {}; } @@ -96852,25 +113702,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -96892,7 +113742,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Hyperparametertuningjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -96903,17 +113753,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Indexendpoints { + export class Resource$Projects$Locations$Metadatastores$Contexts { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexendpoints$Operations; + operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Indexendpoints$Operations(this.context); + new Resource$Projects$Locations$Metadatastores$Contexts$Operations( + this.context + ); } /** - * Creates an IndexEndpoint. + * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. * @example * ```js * // Before running the sample: @@ -96942,43 +113794,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.create({ - * // Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions( + * { + * // Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "artifacts": [], + * // "executions": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -96993,57 +113829,62 @@ export namespace aiplatform_v1 { * @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$Indexendpoints$Create, + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Indexendpoints$Create, + addContextArtifactsAndExecutions( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Indexendpoints$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + addContextArtifactsAndExecutions( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + callback: BodyResponseCallback ): void; - create( + addContextArtifactsAndExecutions( + callback: BodyResponseCallback + ): void; + addContextArtifactsAndExecutions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Create; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; options = {}; } @@ -97056,32 +113897,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an IndexEndpoint. + * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. * @example * ```js * // Before running the sample: @@ -97110,20 +113952,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.delete({ - * // Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.addContextChildren( + * { + * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "childContexts": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -97138,57 +113986,62 @@ export namespace aiplatform_v1 { * @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$Indexendpoints$Delete, + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Delete, + addContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Delete, - callback: BodyResponseCallback + addContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + addContextChildren( + callback: BodyResponseCallback ): void; - delete( + addContextChildren( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Delete; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; options = {}; } @@ -97201,29 +114054,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+context}:addContextChildren').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. + * Creates a Context associated with a MetadataStore. * @example * ```js * // Before running the sample: @@ -97252,28 +114110,47 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.deployIndex({ - * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.create({ + * // The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) + * contextId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndex": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" * // } * } * @@ -97289,58 +114166,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions ): Promise>; - deployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + create( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options?: MethodOptions - ): Promise>; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - deployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Deployindex, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + callback: BodyResponseCallback ): void; - deployIndex( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - deployIndex( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Deployindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Deployindex; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; options = {}; } @@ -97353,7 +114230,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:deployIndex').replace( + url: (rootUrl + '/v1/{+parent}/contexts').replace( /([^:]\/)\/+/g, '$1' ), @@ -97363,22 +114240,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Finds the nearest neighbors of each vector within the request. + * Deletes a stored Context. * @example * ```js * // Before running the sample: @@ -97407,26 +114286,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.findNeighbors({ - * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId", - * // "queries": [], - * // "returnFullDatapoint": false - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.delete({ + * // Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // The force deletion semantics is still undefined. Users should not use this field. + * force: 'placeholder-value', + * // Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * }); * console.log(res.data); * * // Example response * // { - * // "nearestNeighbors": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -97442,62 +114319,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions ): Promise>; - findNeighbors( - params?: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - findNeighbors( - params: Params$Resource$Projects$Locations$Indexendpoints$Findneighbors, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + callback: BodyResponseCallback ): void; - findNeighbors( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - findNeighbors( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Findneighbors - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Findneighbors; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; options = {}; } @@ -97510,34 +114382,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:findNeighbors').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets an IndexEndpoint. + * Retrieves a specific Context. * @example * ```js * // Before running the sample: @@ -97566,29 +114433,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.get({ - * // Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * const res = await aiplatform.projects.locations.metadataStores.contexts.get({ + * // Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "deployedIndexes": [], * // "description": "my_description", * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, * // "etag": "my_etag", * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", * // "updateTime": "my_updateTime" * // } * } @@ -97606,60 +114468,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Get; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; options = {}; } @@ -97684,19 +114543,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists IndexEndpoints in a Location. + * Lists Contexts on the MetadataStore. * @example * ```js * // Before running the sample: @@ -97725,23 +114584,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + * const res = await aiplatform.projects.locations.metadataStores.contexts.list({ + * // Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. * filter: 'placeholder-value', - * // Optional. The standard list page size. + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * // A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', + * // Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', * }); * console.log(res.data); * * // Example response * // { - * // "indexEndpoints": [], + * // "contexts": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -97759,60 +114619,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Indexendpoints$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$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$Indexendpoints$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$List; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; options = {}; } @@ -97825,7 +114686,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexEndpoints').replace( + url: (rootUrl + '/v1/{+parent}/contexts').replace( /([^:]\/)\/+/g, '$1' ), @@ -97840,19 +114701,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Update an existing DeployedIndex under an IndexEndpoint. + * Updates a stored Context. * @example * ```js * // Before running the sample: @@ -97881,43 +114742,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.indexEndpoints.mutateDeployedIndex({ - * // Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * const res = await aiplatform.projects.locations.metadataStores.contexts.patch( + * { + * // If set to true, and the Context is not found, a new Context is created. + * allowMissing: 'placeholder-value', + * // Immutable. The resource name of the Context. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "automaticResources": {}, * // "createTime": "my_createTime", - * // "dedicatedResources": {}, - * // "deployedIndexAuthConfig": {}, - * // "deploymentGroup": "my_deploymentGroup", - * // "deploymentTier": "my_deploymentTier", + * // "description": "my_description", * // "displayName": "my_displayName", - * // "enableAccessLogging": false, - * // "enableDatapointUpsertLogging": false, - * // "id": "my_id", - * // "index": "my_index", - * // "indexSyncTime": "my_indexSyncTime", - * // "privateEndpoints": {}, - * // "pscAutomationConfigs": [], - * // "reservedIpRanges": [] + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "parentContexts": [], + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "updateTime": "my_updateTime" * // } * } * @@ -97933,58 +114800,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions ): Promise>; - mutateDeployedIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + patch( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options?: MethodOptions - ): Promise>; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + callback: BodyResponseCallback ): void; - mutateDeployedIndex( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - mutateDeployedIndex( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; options = {}; } @@ -97997,32 +114864,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:mutateDeployedIndex').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates an IndexEndpoint. + * Purges Contexts. * @example * ```js * // Before running the sample: @@ -98051,55 +114917,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.patch({ - * // Output only. The resource name of the IndexEndpoint. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.metadataStores.contexts.purge( + * { + * // Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "enablePrivateServiceConnect": false, - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "network": "my_network", - * // "privateServiceConnectConfig": {}, - * // "publicEndpointDomainName": "my_publicEndpointDomainName", - * // "publicEndpointEnabled": false, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -98115,61 +114957,57 @@ export namespace aiplatform_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$Indexendpoints$Patch, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Indexendpoints$Patch, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Indexendpoints$Patch, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - patch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexendpoints$Patch; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; options = {}; } @@ -98182,31 +115020,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch. + * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. * @example * ```js * // Before running the sample: @@ -98236,25 +115075,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.readIndexDatapoints({ - * // Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId", - * // "ids": [] - * // } + * await aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph( + * { + * // Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "datapoints": [] + * // "artifacts": [], + * // "events": [], + * // "executions": [] * // } * } * @@ -98270,62 +115104,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions ): Promise>; - readIndexDatapoints( - params?: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + queryContextLineageSubgraph( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - params: Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints, - callback: BodyResponseCallback + queryContextLineageSubgraph( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + callback: BodyResponseCallback ): void; - readIndexDatapoints( - callback: BodyResponseCallback + queryContextLineageSubgraph( + callback: BodyResponseCallback ): void; - readIndexDatapoints( + queryContextLineageSubgraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph + | 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$Indexendpoints$Readindexdatapoints; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; options = {}; } @@ -98338,34 +115172,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:readIndexDatapoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+context}:queryContextLineageSubgraph' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using. + * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. * @example * ```js * // Before running the sample: @@ -98394,29 +115227,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.undeployIndex({ - * // Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - * indexEndpoint: - * 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.removeContextChildren( + * { + * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * context: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedIndexId": "my_deployedIndexId" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "childContexts": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -98431,58 +115261,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: StreamMethodOptions ): Promise>; - undeployIndex( - params?: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + removeContextChildren( + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options?: MethodOptions - ): Promise>; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + ): Promise< + GaxiosResponseWithHTTP2 + >; + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undeployIndex( - params: Params$Resource$Projects$Locations$Indexendpoints$Undeployindex, - callback: BodyResponseCallback + removeContextChildren( + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + callback: BodyResponseCallback ): void; - undeployIndex( - callback: BodyResponseCallback + removeContextChildren( + callback: BodyResponseCallback ): void; - undeployIndex( + removeContextChildren( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Undeployindex - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Undeployindex; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; options = {}; } @@ -98495,7 +115329,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+indexEndpoint}:undeployIndex').replace( + url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( /([^:]\/)\/+/g, '$1' ), @@ -98505,138 +115339,151 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['indexEndpoint'], - pathParams: ['indexEndpoint'], + requiredParams: ['context'], + pathParams: ['context'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions extends StandardParameters { /** - * Required. The resource name of the Location to create the IndexEndpoint in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ - parent?: string; + context?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ - name?: string; + context?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Deployindex extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) */ - indexEndpoint?: string; + contextId?: string; + /** + * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployIndexRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Context; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Findneighbors extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete extends StandardParameters { /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. */ - indexEndpoint?: string; - + etag?: string; /** - * Request body metadata + * The force deletion semantics is still undefined. Users should not use this field. */ - requestBody?: Schema$GoogleCloudAiplatformV1FindNeighborsRequest; + force?: boolean; + /** + * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `index_endpoint` supports = and !=. `index_endpoint` represents the IndexEndpoint ID, ie. the last segment of the IndexEndpoint's resourcename. * `display_name` supports =, != and regex() (uses [re2](https://github.com/google/re2/wiki/Syntax) syntax) * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* or labels:key - key existence A key including a space must be quoted. `labels."a key"`. Some examples: * `index_endpoint="1"` * `display_name="myDisplayName"` * `regex(display_name, "^A") -\> The display name starts with an A. * `labels.myKey="myValue"` + * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** - * Optional. The standard list page size. + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListIndexEndpointsResponse.next_page_token of the previous IndexEndpointService.ListIndexEndpoints call. + * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the IndexEndpoints. Format: `projects/{project\}/locations/{location\}` + * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Mutatedeployedindex extends StandardParameters { - /** - * Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` - */ - indexEndpoint?: string; - + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch extends StandardParameters { /** - * Request body metadata + * If set to true, and the Context is not found, a new Context is created. */ - requestBody?: Schema$GoogleCloudAiplatformV1DeployedIndex; - } - export interface Params$Resource$Projects$Locations$Indexendpoints$Patch extends StandardParameters { + allowMissing?: boolean; /** - * Output only. The resource name of the IndexEndpoint. + * Immutable. The resource name of the Context. */ name?: string; /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * Optional. A FieldMask indicating which fields should be updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1IndexEndpoint; + requestBody?: Schema$GoogleCloudAiplatformV1Context; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Readindexdatapoints extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge extends StandardParameters { /** - * Required. The name of the index endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ - indexEndpoint?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ReadIndexDatapointsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Undeployindex extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph extends StandardParameters { /** - * Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. */ - indexEndpoint?: string; + context?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren extends StandardParameters { + /** + * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + */ + context?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1UndeployIndexRequest; + requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; } - export class Resource$Projects$Locations$Indexendpoints$Operations { + export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -98673,10 +115520,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * }); + * await aiplatform.projects.locations.metadataStores.contexts.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -98696,31 +115545,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -98736,13 +115585,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; options = {}; } @@ -98807,10 +115656,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * }); + * await aiplatform.projects.locations.metadataStores.contexts.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -98830,31 +115681,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -98870,13 +115721,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; options = {}; } @@ -98940,12 +115791,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexEndpoints.operations.get( - * { + * const res = + * await aiplatform.projects.locations.metadataStores.contexts.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * }, - * ); + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -98971,27 +115821,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -98999,7 +115848,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99015,13 +115864,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; options = {}; } @@ -99086,18 +115935,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.metadataStores.contexts.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -99121,29 +115972,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, callback: BodyResponseCallback ): void; list( @@ -99151,7 +116002,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99169,13 +116020,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; options = {}; } @@ -99245,12 +116096,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.indexEndpoints.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/indexEndpoints/my-indexEndpoint/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.metadataStores.contexts.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -99276,27 +116129,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -99304,7 +116156,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99320,13 +116172,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; options = {}; } @@ -99361,25 +116213,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -99401,7 +116253,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Indexendpoints$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -99412,18 +116264,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Indexes { + export class Resource$Projects$Locations$Metadatastores$Executions { context: APIRequestContext; - operations: Resource$Projects$Locations$Indexes$Operations; + operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Indexes$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Metadatastores$Executions$Operations( + this.context + ); } /** - * Creates an Index. + * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. * @example * ```js * // Before running the sample: @@ -99452,41 +116305,205 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.create({ - * // Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.metadataStores.executions.addExecutionEvents( + * { + * // Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * execution: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", - * // "labels": {}, - * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "events": [] + * // } + * }, + * }, + * ); + * console.log(res.data); + * + * // Example 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. + */ + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: StreamMethodOptions + ): Promise>; + addExecutionEvents( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + callback: BodyResponseCallback + ): void; + addExecutionEvents( + callback: BodyResponseCallback + ): void; + addExecutionEvents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['execution'], + pathParams: ['execution'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an Execution associated with a MetadataStore. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.metadataStores.executions.create({ + * // The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + * executionId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -99503,56 +116520,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Indexes$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Indexes$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Create; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; options = {}; } @@ -99565,7 +116587,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+parent}/executions').replace( /([^:]\/)\/+/g, '$1' ), @@ -99580,17 +116602,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. + * Deletes an Execution. * @example * ```js * // Before running the sample: @@ -99619,10 +116643,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.delete({ - * // Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.delete({ + * // Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + * etag: 'placeholder-value', + * // Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }); * console.log(res.data); * * // Example response @@ -99648,27 +116675,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Indexes$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, callback: BodyResponseCallback ): void; delete( @@ -99676,7 +116702,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Delete + | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -99692,12 +116718,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Delete; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; options = {}; } @@ -99732,7 +116759,7 @@ export namespace aiplatform_v1 { } /** - * Gets an Index. + * Retrieves a specific Execution. * @example * ```js * // Before running the sample: @@ -99761,28 +116788,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.get({ - * // Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * }); + * const res = await aiplatform.projects.locations.metadataStores.executions.get( + * { + * // Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "deployedIndexes": [], * // "description": "my_description", * // "displayName": "my_displayName", - * // "encryptionSpec": {}, * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", * // "labels": {}, * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", * // "updateTime": "my_updateTime" * // } * } @@ -99800,56 +116825,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Indexes$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Get; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; options = {}; } @@ -99874,19 +116904,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Indexes in a Location. + * Lists Executions in the MetadataStore. * @example * ```js * // Before running the sample: @@ -99915,23 +116945,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.list({ + * // Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * filter: 'placeholder-value', + * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * orderBy: 'placeholder-value', + * // The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "indexes": [], + * // "executions": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -99949,60 +116981,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Indexes$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$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$Indexes$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$List; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; options = {}; } @@ -100015,7 +117048,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/indexes').replace( + url: (rootUrl + '/v1/{+parent}/executions').replace( /([^:]\/)\/+/g, '$1' ), @@ -100030,19 +117063,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Index. + * Updates a stored Execution. * @example * ```js * // Before running the sample: @@ -100071,43 +117104,48 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.patch({ - * // Output only. The resource name of the Index. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * // The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.metadataStores.executions.patch({ + * // If set to true, and the Execution is not found, a new Execution is created. + * allowMissing: 'placeholder-value', + * // Output only. The resource name of the Execution. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * // Optional. A FieldMask indicating which fields should be updated. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "deployedIndexes": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "indexStats": {}, - * // "indexUpdateMethod": "my_indexUpdateMethod", - * // "labels": {}, - * // "metadata": {}, - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "metadata": {}, * // "name": "my_name", - * // "response": {} + * // "schemaTitle": "my_schemaTitle", + * // "schemaVersion": "my_schemaVersion", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -100124,56 +117162,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Indexes$Patch, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Indexes$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Indexes$Patch; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; options = {}; } @@ -100198,17 +117241,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Remove Datapoints from an Index. + * Purges Executions. * @example * ```js * // Before running the sample: @@ -100237,22 +117282,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.removeDatapoints({ - * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * index: 'projects/my-project/locations/my-location/indexes/my-indexe', + * const res = + * await aiplatform.projects.locations.metadataStores.executions.purge({ + * // Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "datapointIds": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "force": false + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -100267,62 +117321,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions ): Promise>; - removeDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + ): Promise>; + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Removedatapoints, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + callback: BodyResponseCallback ): void; - removeDatapoints( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - removeDatapoints( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Removedatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Removedatapoints; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; options = {}; } @@ -100335,7 +117384,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:removeDatapoints').replace( + url: (rootUrl + '/v1/{+parent}/executions:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -100345,24 +117394,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Add/update Datapoints into an Index. + * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. * @example * ```js * // Before running the sample: @@ -100391,23 +117438,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.upsertDatapoints({ - * // Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - * index: 'projects/my-project/locations/my-location/indexes/my-indexe', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "datapoints": [], - * // "updateMask": "my_updateMask" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs( + * { + * // Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + * execution: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "artifacts": [], + * // "events": [], + * // "executions": [] + * // } * } * * main().catch(e => { @@ -100422,62 +117468,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions ): Promise>; - upsertDatapoints( - params?: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryExecutionInputsAndOutputs( + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upsertDatapoints( - params: Params$Resource$Projects$Locations$Indexes$Upsertdatapoints, - callback: BodyResponseCallback + queryExecutionInputsAndOutputs( + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + callback: BodyResponseCallback ): void; - upsertDatapoints( - callback: BodyResponseCallback + queryExecutionInputsAndOutputs( + callback: BodyResponseCallback ): void; - upsertDatapoints( + queryExecutionInputsAndOutputs( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Upsertdatapoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs + | 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$Indexes$Upsertdatapoints; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Upsertdatapoints; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; options = {}; } @@ -100490,117 +117536,134 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+index}:upsertDatapoints').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['index'], - pathParams: ['index'], + requiredParams: ['execution'], + pathParams: ['execution'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Indexes$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents extends StandardParameters { /** - * Required. The resource name of the Location to create the Index in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` + */ + execution?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create extends StandardParameters { + /** + * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) + */ + executionId?: string; + /** + * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; + requestBody?: Schema$GoogleCloudAiplatformV1Execution; } - export interface Params$Resource$Projects$Locations$Indexes$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete extends StandardParameters { /** - * Required. The name of the Index resource to be deleted. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. + */ + etag?: string; + /** + * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get extends StandardParameters { /** - * Required. The name of the Index resource. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List extends StandardParameters { /** - * The standard list filter. + * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. */ filter?: string; /** - * The standard list page size. + * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call. + * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the Indexes. Format: `projects/{project\}/locations/{location\}` + * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch extends StandardParameters { /** - * Mask specifying which fields to read. + * If set to true, and the Execution is not found, a new Execution is created. */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Indexes$Patch extends StandardParameters { + allowMissing?: boolean; /** - * Output only. The resource name of the Index. + * Output only. The resource name of the Execution. */ name?: string; /** - * The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * Optional. A FieldMask indicating which fields should be updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Index; + requestBody?: Schema$GoogleCloudAiplatformV1Execution; } - export interface Params$Resource$Projects$Locations$Indexes$Removedatapoints extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge extends StandardParameters { /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ - index?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveDatapointsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; } - export interface Params$Resource$Projects$Locations$Indexes$Upsertdatapoints extends StandardParameters { - /** - * Required. The name of the Index resource to be updated. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` - */ - index?: string; - + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs extends StandardParameters { /** - * Request body metadata + * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1UpsertDatapointsRequest; + execution?: string; } - export class Resource$Projects$Locations$Indexes$Operations { + export class Resource$Projects$Locations$Metadatastores$Executions$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -100636,10 +117699,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -100659,31 +117725,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Indexes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Cancel + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100699,13 +117765,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; options = {}; } @@ -100769,10 +117835,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -100792,31 +117861,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Indexes$Operations$Delete, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Delete + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100832,13 +117901,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Delete; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; options = {}; } @@ -100902,10 +117971,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -100931,27 +118003,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Indexes$Operations$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -100959,7 +118030,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Get + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -100975,13 +118046,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Get; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; options = {}; } @@ -101045,18 +118116,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -101080,29 +118154,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Indexes$Operations$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Indexes$Operations$List, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, callback: BodyResponseCallback ): void; list( @@ -101110,7 +118184,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$List + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -101128,13 +118202,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; options = {}; } @@ -101203,12 +118277,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.indexes.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/indexes/my-indexe/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.executions.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -101234,27 +118311,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Indexes$Operations$Wait, + params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -101262,7 +118338,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Indexes$Operations$Wait + | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -101278,13 +118354,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Indexes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; options = {}; } @@ -101319,25 +118395,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -101359,7 +118435,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Indexes$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -101370,33 +118446,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores { + export class Resource$Projects$Locations$Metadatastores$Metadataschemas { context: APIRequestContext; - artifacts: Resource$Projects$Locations$Metadatastores$Artifacts; - contexts: Resource$Projects$Locations$Metadatastores$Contexts; - executions: Resource$Projects$Locations$Metadatastores$Executions; - metadataSchemas: Resource$Projects$Locations$Metadatastores$Metadataschemas; - operations: Resource$Projects$Locations$Metadatastores$Operations; constructor(context: APIRequestContext) { this.context = context; - this.artifacts = new Resource$Projects$Locations$Metadatastores$Artifacts( - this.context - ); - this.contexts = new Resource$Projects$Locations$Metadatastores$Contexts( - this.context - ); - this.executions = - new Resource$Projects$Locations$Metadatastores$Executions(this.context); - this.metadataSchemas = - new Resource$Projects$Locations$Metadatastores$Metadataschemas( - this.context - ); - this.operations = - new Resource$Projects$Locations$Metadatastores$Operations(this.context); } /** - * Initializes a MetadataStore, including allocation of resources. + * Creates a MetadataSchema. * @example * ```js * // Before running the sample: @@ -101425,35 +118482,37 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.create({ - * // The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) - * metadataStoreId: 'placeholder-value', - * // Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.create({ + * // The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + * metadataSchemaId: 'placeholder-value', + * // Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataplexConfig": {}, - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "state": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "name": "my_name", + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", * // "name": "my_name", - * // "response": {} + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" * // } * } * @@ -101470,56 +118529,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Create, + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Create; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; options = {}; } @@ -101532,7 +118596,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -101547,161 +118611,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.metadataStores.delete({ - * // Deprecated: Field is no longer supported. - * force: 'placeholder-value', - * // Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); - * 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$Metadatastores$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + return createAPIRequest( + parameters ); - } else { - return createAPIRequest(parameters); } } /** - * Retrieves a specific MetadataStore. + * Retrieves a specific MetadataSchema. * @example * ```js * // Before running the sample: @@ -101730,21 +118652,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.get({ - * // Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.get({ + * // Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/metadataSchemas/my-metadataSchema', + * }); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "dataplexConfig": {}, * // "description": "my_description", - * // "encryptionSpec": {}, * // "name": "my_name", - * // "state": {}, - * // "updateTime": "my_updateTime" + * // "schema": "my_schema", + * // "schemaType": "my_schemaType", + * // "schemaVersion": "my_schemaVersion" * // } * } * @@ -101761,60 +118683,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Get, + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get + | 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$Metadatastores$Get; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$Get; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; options = {}; } @@ -101839,19 +118762,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists MetadataStores for a Location. + * Lists MetadataSchemas. * @example * ```js * // Before running the sample: @@ -101880,19 +118803,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.list({ - * // The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.metadataStores.metadataSchemas.list({ + * // A query to filter available MetadataSchemas for matching results. + * filter: 'placeholder-value', + * // The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * pageSize: 'placeholder-value', + * // A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * pageToken: 'placeholder-value', + * // Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * parent: + * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * }); * console.log(res.data); * * // Example response * // { - * // "metadataStores": [], + * // "metadataSchemas": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -101910,60 +118837,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$List, + params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$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$Metadatastores$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Metadatastores$List; + params = + {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; options = {}; } @@ -101976,7 +118904,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataStores').replace( + url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -101991,77 +118919,66 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create extends StandardParameters { /** - * The {metadatastore\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataStores in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataStore.) + * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) */ - metadataStoreId?: string; + metadataSchemaId?: string; /** - * Required. The resource name of the Location where the MetadataStore should be created. Format: `projects/{project\}/locations/{location\}/` + * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataStore; + requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; } - export interface Params$Resource$Projects$Locations$Metadatastores$Delete extends StandardParameters { - /** - * Deprecated: Field is no longer supported. - */ - force?: boolean; + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get extends StandardParameters { /** - * Required. The resource name of the MetadataStore to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List extends StandardParameters { /** - * Required. The resource name of the MetadataStore to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * A query to filter available MetadataSchemas for matching results. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$List extends StandardParameters { + filter?: string; /** - * The maximum number of Metadata Stores to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListMetadataStores call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) */ pageToken?: string; /** - * Required. The Location whose MetadataStores should be listed. Format: `projects/{project\}/locations/{location\}` + * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` */ parent?: string; } - export class Resource$Projects$Locations$Metadatastores$Artifacts { + export class Resource$Projects$Locations$Metadatastores$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Artifacts$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Artifacts$Operations( - this.context - ); } /** - * Creates an Artifact associated with a MetadataStore. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -102091,49 +119008,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.create({ - * // The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) - * artifactId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } - * }, + * await aiplatform.projects.locations.metadataStores.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } + * // {} * } * * main().catch(e => { @@ -102148,58 +119030,54 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Artifacts$Create, + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + cancel( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; options = {}; } @@ -102212,332 +119090,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').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 Artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.metadataStores.artifacts.delete({ - * // Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * }); - * 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$Metadatastores$Artifacts$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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); - } - } - - /** - * Retrieves a specific Artifact. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.metadataStores.artifacts.get({ - * // Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } - * } - * - * 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$Metadatastores$Artifacts$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.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( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Artifacts in the MetadataStore. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -102566,28 +119141,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.artifacts.list( - * { - * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }, - * ); + * const res = + * await aiplatform.projects.locations.metadataStores.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "artifacts": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -102602,62 +119164,54 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Artifacts$List, + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + delete( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$List; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; options = {}; } @@ -102670,34 +119224,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a stored Artifact. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -102726,50 +119275,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.patch({ - * // If set to true, and the Artifact is not found, a new Artifact is created. - * allowMissing: 'placeholder-value', - * // Output only. The resource name of the Artifact. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // Optional. A FieldMask indicating which fields should be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.metadataStores.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime", - * // "uri": "my_uri" + * // "response": {} * // } * } * @@ -102785,58 +119305,57 @@ export namespace aiplatform_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$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; options = {}; } @@ -102850,7 +119369,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -102861,19 +119380,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Purges Artifacts. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -102903,29 +119420,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.purge({ - * // Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, + * await aiplatform.projects.locations.metadataStores.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -102941,58 +119454,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; options = {}; } @@ -103005,32 +119522,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/artifacts:purge').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -103060,24 +119579,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.queryArtifactLineageSubgraph( - * { - * // Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - * artifact: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. - * maxHops: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.metadataStores.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -103093,62 +119609,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions ): Promise>; - queryArtifactLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - queryArtifactLineageSubgraph( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph; + {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; options = {}; } @@ -103161,138 +119672,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+artifact}:queryArtifactLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['artifact'], - pathParams: ['artifact'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Create extends StandardParameters { - /** - * The {artifact\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` If not provided, the Artifact's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Artifacts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Artifact.) - */ - artifactId?: string; - /** - * Required. The resource name of the MetadataStore where the Artifact should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; + name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Delete extends StandardParameters { - /** - * Optional. The etag of the Artifact to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the Artifact to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get extends StandardParameters { /** - * Required. The resource name of the Artifact to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List extends StandardParameters { /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Artifacts based on the contexts to which they belong, use the function operator with the full resource name `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * The standard list filter. */ filter?: string; /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of Artifacts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListArtifacts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * The standard list page token. */ pageToken?: string; /** - * Required. The MetadataStore whose Artifacts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Patch extends StandardParameters { - /** - * If set to true, and the Artifact is not found, a new Artifact is created. - */ - allowMissing?: boolean; + export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait extends StandardParameters { /** - * Output only. The resource name of the Artifact. + * The name of the operation resource to wait on. */ name?: string; /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Artifact; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Purge extends StandardParameters { - /** - * Required. The metadata store to purge Artifacts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeArtifactsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Queryartifactlineagesubgraph extends StandardParameters { - /** - * Required. The resource name of the Artifact whose Lineage needs to be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/artifacts/{artifact\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - */ - artifact?: string; - /** - * Filter specifying the boolean condition for the Artifacts to satisfy in order to be part of the Lineage Subgraph. The syntax to define filter query is based on https://google.aip.dev/160. The supported set of filters include the following: * **Attribute filtering**: For example: `display_name = "test"` Supported fields include: `name`, `display_name`, `uri`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"` * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` Each of the above supported filter types can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * Specifies the size of the lineage graph in terms of number of hops from the specified artifact. Negative Value: INVALID_ARGUMENT error is returned 0: Only input artifact is returned. No value: Transitive closure is performed to return the complete graph. + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - maxHops?: number; + timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Artifacts$Operations { + export class Resource$Projects$Locations$Migratableresources { context: APIRequestContext; + operations: Resource$Projects$Locations$Migratableresources$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Migratableresources$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. * @example * ```js * // Before running the sample: @@ -103322,16 +119787,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', + * await aiplatform.projects.locations.migratableResources.batchMigrate({ + * // Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "migrateResourceRequests": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -103346,54 +119823,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + batchMigrate( + params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, + ): Promise>; + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel, - callback: BodyResponseCallback + batchMigrate( + params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchMigrate( + callback: BodyResponseCallback + ): void; + batchMigrate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; options = {}; } @@ -103406,29 +119886,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/migratableResources:batchMigrate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. * @example * ```js * // Before running the sample: @@ -103457,17 +119939,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.migratableResources.search({ + * // Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "pageSize": 0, + * // "pageToken": "my_pageToken" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "migratableResources": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -103482,54 +119974,62 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Artifacts$Operations$Delete, + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + search( + params?: Params$Resource$Projects$Locations$Migratableresources$Search, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Migratableresources$Search, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + search( + callback: BodyResponseCallback + ): void; + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Migratableresources$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete; + {} as Params$Resource$Projects$Locations$Migratableresources$Search; options = {}; } @@ -103542,29 +120042,64 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/migratableResources:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate extends StandardParameters { + /** + * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchMigrateResourcesRequest; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Search extends StandardParameters { + /** + * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SearchMigratableResourcesRequest; + } + + export class Resource$Projects$Locations$Migratableresources$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -103594,22 +120129,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.migratableResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -103624,58 +120151,54 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Artifacts$Operations$Get, + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + cancel( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; options = {}; } @@ -103688,8 +120211,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -103700,17 +120223,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -103740,28 +120263,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.migratableResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -103776,62 +120285,54 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Artifacts$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$List; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; options = {}; } @@ -103844,11 +120345,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -103859,19 +120357,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -103901,14 +120397,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.artifacts.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/artifacts/my-artifact/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.migratableResources.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -103933,156 +120425,92 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, callback: BodyResponseCallback ): void; - wait( + get( callback: BodyResponseCallback ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').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$Metadatastores$Artifacts$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Artifacts$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migratableresources$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Metadatastores$Contexts { - context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Contexts$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Contexts$Operations( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } } /** - * Adds a set of Artifacts and Executions to a Context. If any of the Artifacts or Executions have already been added to a Context, they are simply skipped. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -104112,26 +120540,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.addContextArtifactsAndExecutions( - * { - * // Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "artifacts": [], - * // "executions": [] - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.migratableResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 => { @@ -104146,62 +120574,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: StreamMethodOptions ): Promise>; - addContextArtifactsAndExecutions( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + list( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - addContextArtifactsAndExecutions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Operations$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$Metadatastores$Contexts$Addcontextartifactsandexecutions; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; options = {}; } @@ -104214,33 +120642,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+context}:addContextArtifactsAndExecutions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds a set of Contexts as children to a parent Context. If any of the child Contexts have already been added to the parent Context, they are simply skipped. If this call would create a cycle or cause any Context to have more than 10 parents, the request will fail with an INVALID_ARGUMENT error. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -104270,25 +120699,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.addContextChildren( - * { - * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "childContexts": [] - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.migratableResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -104303,62 +120729,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: StreamMethodOptions ): Promise>; - addContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + wait( + params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + callback: BodyResponseCallback ): void; - addContextChildren( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - addContextChildren( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren; + {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; options = {}; } @@ -104371,34 +120792,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+context}:addContextChildren').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel extends StandardParameters { /** - * Creates a Context associated with a MetadataStore. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Migratableresources$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( + this.context + ); + } + + /** + * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. * @example * ```js * // Before running the sample: @@ -104428,27 +120907,38 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.create({ - * // The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) - * contextId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.create({ + * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], * // "createTime": "my_createTime", - * // "description": "my_description", * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, * // "labels": {}, - * // "metadata": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * }, @@ -104457,16 +120947,30 @@ export namespace aiplatform_v1 { * * // Example response * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], * // "createTime": "my_createTime", - * // "description": "my_description", * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, * // "labels": {}, - * // "metadata": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * } @@ -104484,57 +120988,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Create; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; options = {}; } @@ -104547,10 +121055,9 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -104562,19 +121069,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a stored Context. + * Deletes a ModelDeploymentMonitoringJob. * @example * ```js * // Before running the sample: @@ -104604,13 +121111,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.delete({ - * // Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // The force deletion semantics is still undefined. Users should not use this field. - * force: 'placeholder-value', - * // Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete({ + * // Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', * }); * console.log(res.data); * @@ -104637,27 +121140,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, callback: BodyResponseCallback ): void; delete( @@ -104665,7 +121167,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -104681,13 +121183,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; options = {}; } @@ -104722,7 +121224,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific Context. + * Gets a ModelDeploymentMonitoringJob. * @example * ```js * // Before running the sample: @@ -104751,24 +121253,39 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.get({ - * // Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * }); + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.get({ + * // Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * }); * console.log(res.data); * * // Example response * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], * // "createTime": "my_createTime", - * // "description": "my_description", * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, * // "labels": {}, - * // "metadata": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * } @@ -104786,57 +121303,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Get; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; options = {}; } @@ -104861,19 +121382,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Contexts on the MetadataStore. + * Lists ModelDeploymentMonitoringJobs in a Location. * @example * ```js * // Before running the sample: @@ -104902,24 +121423,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.list({ - * // Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "contexts": [], + * // "modelDeploymentMonitoringJobs": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -104937,61 +121458,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$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$Metadatastores$Contexts$List; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$List; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; options = {}; } @@ -105004,10 +121525,9 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -105019,19 +121539,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Context. + * Updates a ModelDeploymentMonitoringJob. * @example * ```js * // Before running the sample: @@ -105060,49 +121580,54 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.patch( - * { - * // If set to true, and the Context is not found, a new Context is created. - * allowMissing: 'placeholder-value', - * // Immutable. The resource name of the Context. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', - * // Optional. A FieldMask indicating which fields should be updated. + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch({ + * // Output only. Resource name of a ModelDeploymentMonitoringJob. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * // Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", + * // "bigqueryTables": [], * // "createTime": "my_createTime", - * // "description": "my_description", * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "enableMonitoringPipelineLogs": false, + * // "encryptionSpec": {}, + * // "endpoint": "my_endpoint", + * // "error": {}, * // "labels": {}, - * // "metadata": {}, + * // "latestMonitoringPipelineMetadata": {}, + * // "logTtl": "my_logTtl", + * // "loggingSamplingStrategy": {}, + * // "modelDeploymentMonitoringObjectiveConfigs": [], + * // "modelDeploymentMonitoringScheduleConfig": {}, + * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", + * // "nextScheduleTime": "my_nextScheduleTime", + * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", + * // "samplePredictInstance": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "scheduleState": "my_scheduleState", + * // "state": "my_state", + * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * }, - * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "parentContexts": [], - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -105119,57 +121644,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options?: MethodOptions - ): Promise>; + ): Promise>; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; options = {}; } @@ -105194,19 +121718,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Purges Contexts. + * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. * @example * ```js * // Before running the sample: @@ -105235,32 +121757,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.contexts.purge( - * { - * // Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * const res = + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause({ + * // Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } + * // {} * }, - * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -105275,58 +121786,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + pause( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + callback: BodyResponseCallback ): void; - purge( + pause(callback: BodyResponseCallback): void; + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; options = {}; } @@ -105339,32 +121846,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contexts:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph. + * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. * @example * ```js * // Before running the sample: @@ -105394,21 +121898,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.queryContextLineageSubgraph( - * { - * // Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume({ + * // Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} * }, - * ); + * }); * console.log(res.data); * * // Example response - * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] - * // } + * // {} * } * * main().catch(e => { @@ -105423,62 +121926,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, options: StreamMethodOptions ): Promise>; - queryContextLineageSubgraph( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + resume( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - queryContextLineageSubgraph( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + callback: BodyResponseCallback ): void; - queryContextLineageSubgraph( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; options = {}; } @@ -105491,33 +121986,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+context}:queryContextLineageSubgraph' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Remove a set of children contexts from a parent Context. If any of the child Contexts were NOT added to the parent Context, they are simply skipped. + * Searches Model Monitoring Statistics generated within a given time window. * @example * ```js * // Before running the sample: @@ -105547,17 +122038,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.removeContextChildren( + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies( * { - * // Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - * context: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * // Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * modelDeploymentMonitoringJob: + * 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "childContexts": [] + * // "deployedModelId": "my_deployedModelId", + * // "endTime": "my_endTime", + * // "featureDisplayName": "my_featureDisplayName", + * // "objectives": [], + * // "pageSize": 0, + * // "pageToken": "my_pageToken", + * // "startTime": "my_startTime" * // } * }, * }, @@ -105565,7 +122062,10 @@ export namespace aiplatform_v1 { * console.log(res.data); * * // Example response - * // {} + * // { + * // "monitoringStats": [], + * // "nextPageToken": "my_nextPageToken" + * // } * } * * main().catch(e => { @@ -105580,62 +122080,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: StreamMethodOptions ): Promise>; - removeContextChildren( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + searchModelDeploymentMonitoringStatsAnomalies( + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - removeContextChildren( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren, - callback: BodyResponseCallback + searchModelDeploymentMonitoringStatsAnomalies( + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + callback: BodyResponseCallback ): void; - removeContextChildren( - callback: BodyResponseCallback + searchModelDeploymentMonitoringStatsAnomalies( + callback: BodyResponseCallback ): void; - removeContextChildren( + searchModelDeploymentMonitoringStatsAnomalies( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren - | BodyResponseCallback + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies + | 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$Metadatastores$Contexts$Removecontextchildren; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; options = {}; } @@ -105648,161 +122148,128 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+context}:removeContextChildren').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['context'], - pathParams: ['context'], + requiredParams: ['modelDeploymentMonitoringJob'], + pathParams: ['modelDeploymentMonitoringJob'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextartifactsandexecutions extends StandardParameters { - /** - * Required. The resource name of the Context that the Artifacts and Executions belong to. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextArtifactsAndExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Addcontextchildren extends StandardParameters { - /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` - */ - context?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddContextChildrenRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Create extends StandardParameters { - /** - * The {context\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}`. If not provided, the Context's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Contexts in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Context.) - */ - contextId?: string; + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create extends StandardParameters { /** - * Required. The resource name of the MetadataStore where the Context should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Delete extends StandardParameters { - /** - * Optional. The etag of the Context to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * The force deletion semantics is still undefined. Users should not use this field. + * Request body metadata */ - force?: boolean; + requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete extends StandardParameters { /** - * Required. The resource name of the Context to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get extends StandardParameters { /** - * Required. The resource name of the Context to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List extends StandardParameters { /** - * Filter specifying the boolean condition for the Contexts to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..`. For example: `metadata.field_1.number_value = 10.0`. In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Parent Child filtering**: To filter Contexts based on parent-child relationship use the HAS operator as follows: ``` parent_contexts: "projects//locations//metadataStores//contexts/" child_contexts: "projects//locations//metadataStores//contexts/" ``` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` */ filter?: string; /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Contexts to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListContexts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * The standard list page token. */ pageToken?: string; /** - * Required. The MetadataStore whose Contexts should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Patch extends StandardParameters { /** - * If set to true, and the Context is not found, a new Context is created. + * Mask specifying which fields to read */ - allowMissing?: boolean; + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch extends StandardParameters { /** - * Immutable. The resource name of the Context. + * Output only. Resource name of a ModelDeploymentMonitoringJob. */ name?: string; /** - * Optional. A FieldMask indicating which fields should be updated. + * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Context; + requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Purge extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause extends StandardParameters { /** - * Required. The metadata store to purge Contexts from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeContextsRequest; + requestBody?: Schema$GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Querycontextlineagesubgraph extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume extends StandardParameters { /** - * Required. The resource name of the Context whose Artifacts and Executions should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` The request may error with FAILED_PRECONDITION if the number of Artifacts, the number of Executions, or the number of Events that would be returned for the Context exceeds 1000. + * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ - context?: string; + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Removecontextchildren extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies extends StandardParameters { /** - * Required. The resource name of the parent Context. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/contexts/{context\}` + * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` */ - context?: string; + modelDeploymentMonitoringJob?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1RemoveContextChildrenRequest; + requestBody?: Schema$GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest; } - export class Resource$Projects$Locations$Metadatastores$Contexts$Operations { + export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -105839,10 +122306,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.cancel( + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }, * ); * console.log(res.data); @@ -105864,31 +122331,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -105904,13 +122371,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; options = {}; } @@ -105975,10 +122442,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.delete( + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * }, * ); * console.log(res.data); @@ -106000,31 +122467,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106040,13 +122507,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; options = {}; } @@ -106111,10 +122578,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', - * }); + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -106140,27 +122609,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -106168,7 +122636,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106184,13 +122652,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; options = {}; } @@ -106255,12 +122723,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.list( + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list( * { * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context', + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -106292,29 +122760,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -106322,7 +122790,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106340,13 +122808,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; options = {}; } @@ -106416,10 +122884,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.contexts.operations.wait( + * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait( * { * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/contexts/my-context/operations/my-operation', + * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }, @@ -106449,27 +122917,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait, + params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -106477,7 +122944,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait + | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -106493,13 +122960,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait; + {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; options = {}; } @@ -106534,25 +123001,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -106574,7 +123041,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Metadatastores$Contexts$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -106585,19 +123052,22 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Metadatastores$Executions { + export class Resource$Projects$Locations$Models { context: APIRequestContext; - operations: Resource$Projects$Locations$Metadatastores$Executions$Operations; + evaluations: Resource$Projects$Locations$Models$Evaluations; + operations: Resource$Projects$Locations$Models$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Metadatastores$Executions$Operations( - this.context - ); + this.evaluations = new Resource$Projects$Locations$Models$Evaluations( + this.context + ); + this.operations = new Resource$Projects$Locations$Models$Operations( + this.context + ); } /** - * Adds Events to the specified Execution. An Event indicates whether an Artifact was used as an input or output for an Execution. If an Event already exists between the Execution and the Artifact, the Event is skipped. + * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. * @example * ```js * // Before running the sample: @@ -106626,26 +123096,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.addExecutionEvents( - * { - * // Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * execution: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', + * const res = await aiplatform.projects.locations.models.copy({ + * // Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "events": [] - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "customServiceAccount": "my_customServiceAccount", + * // "encryptionSpec": {}, + * // "modelId": "my_modelId", + * // "parentModel": "my_parentModel", + * // "sourceModel": "my_sourceModel" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -106660,62 +123136,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions ): Promise>; - addExecutionEvents( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + copy( + params?: Params$Resource$Projects$Locations$Models$Copy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + ): Promise>; + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, + copy( + params: Params$Resource$Projects$Locations$Models$Copy, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - addExecutionEvents( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents, - callback: BodyResponseCallback + copy( + params: Params$Resource$Projects$Locations$Models$Copy, + callback: BodyResponseCallback ): void; - addExecutionEvents( - callback: BodyResponseCallback + copy( + callback: BodyResponseCallback ): void; - addExecutionEvents( + copy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Copy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + {}) as Params$Resource$Projects$Locations$Models$Copy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Addexecutionevents; + params = {} as Params$Resource$Projects$Locations$Models$Copy; options = {}; } @@ -106728,7 +123198,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+execution}:addExecutionEvents').replace( + url: (rootUrl + '/v1/{+parent}/models:copy').replace( /([^:]\/)\/+/g, '$1' ), @@ -106738,24 +123208,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates an Execution associated with a MetadataStore. + * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. * @example * ```js * // Before running the sample: @@ -106784,47 +123252,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.create({ - * // The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) - * executionId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.delete({ + * // Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * name: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -106840,62 +123280,197 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Executions$Create, + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + delete( + params?: Params$Resource$Projects$Locations$Models$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, + delete( + params: Params$Resource$Projects$Locations$Models$Delete, options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Models$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.models.deleteVersion({ + * // Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + * name: 'projects/my-project/locations/my-location/models/my-model', + * }); + * 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. + */ + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, + options: StreamMethodOptions + ): Promise>; + deleteVersion( + params?: Params$Resource$Projects$Locations$Models$Deleteversion, + options?: MethodOptions + ): Promise>; + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Create, - callback: BodyResponseCallback + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + deleteVersion( + params: Params$Resource$Projects$Locations$Models$Deleteversion, + callback: BodyResponseCallback ): void; - create( + deleteVersion( + callback: BodyResponseCallback + ): void; + deleteVersion( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Deleteversion + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + {}) as Params$Resource$Projects$Locations$Models$Deleteversion; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Create; + params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; options = {}; } @@ -106908,34 +123483,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( + url: (rootUrl + '/v1/{+name}:deleteVersion').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes an Execution. + * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. * @example * ```js * // Before running the sample: @@ -106964,13 +123537,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.delete({ - * // Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - * etag: 'placeholder-value', - * // Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }); + * const res = await aiplatform.projects.locations.models.export({ + * // Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. + * name: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "outputConfig": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -106995,36 +123573,35 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Executions$Delete, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + export( + params?: Params$Resource$Projects$Locations$Models$Export, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + export( + params: Params$Resource$Projects$Locations$Models$Export, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Delete, + export( + params: Params$Resource$Projects$Locations$Models$Export, callback: BodyResponseCallback ): void; - delete( + export( callback: BodyResponseCallback ): void; - delete( + export( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Delete + | Params$Resource$Projects$Locations$Models$Export | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -107040,13 +123617,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + {}) as Params$Resource$Projects$Locations$Models$Export; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Export; options = {}; } @@ -107059,8 +123635,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -107081,7 +123657,7 @@ export namespace aiplatform_v1 { } /** - * Retrieves a specific Execution. + * Gets a Model. * @example * ```js * // Before running the sample: @@ -107110,27 +123686,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.executions.get( - * { - * // Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }, - * ); + * const res = await aiplatform.projects.locations.models.get({ + * // Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. + * name: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], * // "description": "my_description", * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "etag": "my_etag", + * // "explanationSpec": {}, * // "labels": {}, * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" * // } * } * @@ -107147,61 +123745,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params?: Params$Resource$Projects$Locations$Models$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, + params: Params$Resource$Projects$Locations$Models$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + {}) as Params$Resource$Projects$Locations$Models$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Get; + params = {} as Params$Resource$Projects$Locations$Models$Get; options = {}; } @@ -107226,19 +123819,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Executions in the MetadataStore. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -107267,25 +123860,168 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.list({ - * // Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - * filter: 'placeholder-value', - * // How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - * orderBy: 'placeholder-value', - * // The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = await aiplatform.projects.locations.models.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/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { - * // "executions": [], + * // "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$Locations$Models$Getiampolicy, + options: StreamMethodOptions + ): Promise>; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Getiampolicy, + options?: MethodOptions + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Models$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').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); + } + } + + /** + * Lists Models in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.models.list({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "models": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -107303,61 +124039,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params?: Params$Resource$Projects$Locations$Models$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Models$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, + params: Params$Resource$Projects$Locations$Models$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$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$Metadatastores$Executions$List; + {}) as Params$Resource$Projects$Locations$Models$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$List; + params = {} as Params$Resource$Projects$Locations$Models$List; options = {}; } @@ -107370,7 +124105,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions').replace( + url: (rootUrl + '/v1/{+parent}/models').replace( /([^:]\/)\/+/g, '$1' ), @@ -107385,19 +124120,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a stored Execution. + * Lists checkpoints of the specified model version. * @example * ```js * // Before running the sample: @@ -107426,48 +124161,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.patch({ - * // If set to true, and the Execution is not found, a new Execution is created. - * allowMissing: 'placeholder-value', - * // Output only. The resource name of the Execution. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * // Optional. A FieldMask indicating which fields should be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.listCheckpoints({ + * // Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + * pageToken: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "schemaTitle": "my_schemaTitle", - * // "schemaVersion": "my_schemaVersion", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "checkpoints": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -107483,62 +124190,62 @@ export namespace aiplatform_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$Metadatastores$Executions$Patch, + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + listCheckpoints( + params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Patch, - callback: BodyResponseCallback + listCheckpoints( + params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + listCheckpoints( + callback: BodyResponseCallback ): void; - patch( + listCheckpoints( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listcheckpoints + | 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$Metadatastores$Executions$Patch; + {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Patch; + {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; options = {}; } @@ -107551,8 +124258,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:listCheckpoints').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -107563,19 +124273,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Purges Executions. + * Lists versions of the specified model. * @example * ```js * // Before running the sample: @@ -107604,30 +124314,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.purge({ - * // Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "force": false - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.listVersions({ + * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` + * filter: 'placeholder-value', + * // Required. The name of the model to list versions for. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. + * pageToken: 'placeholder-value', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "models": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -107643,58 +124349,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + listVersions( + params?: Params$Resource$Projects$Locations$Models$Listversions, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Purge, - callback: BodyResponseCallback + listVersions( + params: Params$Resource$Projects$Locations$Models$Listversions, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + listVersions( + callback: BodyResponseCallback ): void; - purge( + listVersions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Listversions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + {}) as Params$Resource$Projects$Locations$Models$Listversions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Purge; + params = {} as Params$Resource$Projects$Locations$Models$Listversions; options = {}; } @@ -107707,32 +124416,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/executions:purge').replace( + url: (rootUrl + '/v1/{+name}:listVersions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events. + * Merges a set of aliases for a Model version. * @example * ```js * // Before running the sample: @@ -107761,21 +124472,57 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.queryExecutionInputsAndOutputs( - * { - * // Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - * execution: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * }, - * ); + * const res = await aiplatform.projects.locations.models.mergeVersionAliases({ + * // Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` + * name: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "versionAliases": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "artifacts": [], - * // "events": [], - * // "executions": [] + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, + * // "name": "my_name", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" * // } * } * @@ -107791,62 +124538,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions ): Promise>; - queryExecutionInputsAndOutputs( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + mergeVersionAliases( + params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + ): Promise>; + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs, - callback: BodyResponseCallback + mergeVersionAliases( + params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( - callback: BodyResponseCallback + mergeVersionAliases( + callback: BodyResponseCallback ): void; - queryExecutionInputsAndOutputs( + mergeVersionAliases( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Mergeversionaliases + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {}) as Params$Resource$Projects$Locations$Models$Mergeversionaliases; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs; + {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; options = {}; } @@ -107859,141 +124602,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+execution}:queryExecutionInputsAndOutputs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:mergeVersionAliases').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['execution'], - pathParams: ['execution'], + 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$Projects$Locations$Metadatastores$Executions$Addexecutionevents extends StandardParameters { - /** - * Required. The resource name of the Execution that the Events connect Artifacts with. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - execution?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AddExecutionEventsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Create extends StandardParameters { - /** - * The {execution\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` If not provided, the Execution's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all Executions in the parent MetadataStore. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting Execution.) - */ - executionId?: string; - /** - * Required. The resource name of the MetadataStore where the Execution should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Delete extends StandardParameters { - /** - * Optional. The etag of the Execution to delete. If this is provided, it must match the server's etag. Otherwise, the request will fail with a FAILED_PRECONDITION. - */ - etag?: string; - /** - * Required. The resource name of the Execution to delete. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Get extends StandardParameters { - /** - * Required. The resource name of the Execution to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$List extends StandardParameters { - /** - * Filter specifying the boolean condition for the Executions to satisfy in order to be part of the result set. The syntax to define filter query is based on https://google.aip.dev/160. Following are the supported set of filters: * **Attribute filtering**: For example: `display_name = "test"`. Supported fields include: `name`, `display_name`, `state`, `schema_title`, `create_time`, and `update_time`. Time fields, such as `create_time` and `update_time`, require values specified in RFC-3339 format. For example: `create_time = "2020-11-19T11:30:00-04:00"`. * **Metadata field**: To filter on metadata fields use traversal operation as follows: `metadata..` For example: `metadata.field_1.number_value = 10.0` In case the field name contains special characters (such as colon), one can embed it inside double quote. For example: `metadata."field:1".number_value = 10.0` * **Context based filtering**: To filter Executions based on the contexts to which they belong use the function operator with the full resource name: `in_context()`. For example: `in_context("projects//locations//metadataStores//contexts/")` Each of the above supported filters can be combined together using logical operators (`AND` & `OR`). Maximum nested expression depth allowed is 5. For example: `display_name = "test" AND metadata.field1.bool_value = true`. - */ - filter?: string; - /** - * How the list of messages is ordered. Specify the values to order by and an ordering operation. The default sorting order is ascending. To specify descending order for a field, users append a " desc" suffix; for example: "foo desc, bar". Subfields are specified with a `.` character, such as foo.bar. see https://google.aip.dev/132#ordering for more details. - */ - orderBy?: string; - /** - * The maximum number of Executions to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - */ - pageSize?: number; - /** - * A page token, received from a previous MetadataService.ListExecutions call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with an INVALID_ARGUMENT error.) - */ - pageToken?: string; - /** - * Required. The MetadataStore whose Executions should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Patch extends StandardParameters { - /** - * If set to true, and the Execution is not found, a new Execution is created. - */ - allowMissing?: boolean; - /** - * Output only. The resource name of the Execution. - */ - name?: string; - /** - * Optional. A FieldMask indicating which fields should be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Execution; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Purge extends StandardParameters { - /** - * Required. The metadata store to purge Executions from. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeExecutionsRequest; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Queryexecutioninputsandoutputs extends StandardParameters { - /** - * Required. The resource name of the Execution whose input and output Artifacts should be retrieved as a LineageSubgraph. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/executions/{execution\}` - */ - execution?: string; - } - - export class Resource$Projects$Locations$Metadatastores$Executions$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates a Model. * @example * ```js * // Before running the sample: @@ -108022,17 +124658,94 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.patch({ + * // Identifier. The resource name of the Model. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, + * // "name": "my_name", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "artifactUri": "my_artifactUri", + * // "baseModelSource": {}, + * // "checkpoints": [], + * // "containerSpec": {}, + * // "createTime": "my_createTime", + * // "dataStats": {}, + * // "defaultCheckpointId": "my_defaultCheckpointId", + * // "deployedModels": [], + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "explanationSpec": {}, + * // "labels": {}, + * // "metadata": {}, + * // "metadataArtifact": "my_metadataArtifact", + * // "metadataSchemaUri": "my_metadataSchemaUri", + * // "modelSourceInfo": {}, + * // "name": "my_name", + * // "originalModelInfo": {}, + * // "pipelineJob": "my_pipelineJob", + * // "predictSchemata": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "supportedDeploymentResourcesTypes": [], + * // "supportedExportFormats": [], + * // "supportedInputStorageFormats": [], + * // "supportedOutputStorageFormats": [], + * // "trainingPipeline": "my_trainingPipeline", + * // "updateTime": "my_updateTime", + * // "versionAliases": [], + * // "versionCreateTime": "my_versionCreateTime", + * // "versionDescription": "my_versionDescription", + * // "versionId": "my_versionId", + * // "versionUpdateTime": "my_versionUpdateTime" + * // } * } * * main().catch(e => { @@ -108047,54 +124760,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Models$Patch, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Models$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Models$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Models$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Models$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Models$Patch; options = {}; } @@ -108107,8 +124823,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -108119,17 +124835,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -108158,17 +124876,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.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/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 + * // } * } * * main().catch(e => { @@ -108183,54 +124910,55 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Executions$Operations$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Models$Setiampolicy, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Models$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; options = {}; } @@ -108243,29 +124971,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -108294,22 +125025,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.models.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: 'projects/my-project/locations/my-location/models/my-model', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -108325,58 +125051,62 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Executions$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Models$Testiampermissions, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Models$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get; + {} as Params$Resource$Projects$Locations$Models$Testiampermissions; options = {}; } @@ -108389,29 +125119,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Incrementally update the dataset used for an examples model. * @example * ```js * // Before running the sample: @@ -108441,27 +125176,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * await aiplatform.projects.locations.models.updateExplanationDataset({ + * // Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * model: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "examples": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -108477,62 +125212,57 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Executions$Operations$List, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + updateExplanationDataset( + params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + ): Promise>; + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List, - callback: BodyResponseCallback + updateExplanationDataset( + params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + updateExplanationDataset( + callback: BodyResponseCallback ): void; - list( + updateExplanationDataset( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Updateexplanationdataset + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List; + {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; options = {}; } @@ -108545,34 +125275,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+model}:updateExplanationDataset').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Uploads a Model artifact into Vertex AI. * @example * ```js * // Before running the sample: @@ -108601,15 +125329,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.executions.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/executions/my-execution/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.models.upload({ + * // Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "model": {}, + * // "modelId": "my_modelId", + * // "parentModel": "my_parentModel", + * // "serviceAccount": "my_serviceAccount" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -108634,36 +125368,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + upload( + params?: Params$Resource$Projects$Locations$Models$Upload, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait, + upload( + params: Params$Resource$Projects$Locations$Models$Upload, callback: BodyResponseCallback ): void; - wait( + upload( callback: BodyResponseCallback ): void; - wait( + upload( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait + | Params$Resource$Projects$Locations$Models$Upload | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -108679,13 +125412,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Models$Upload; options = {}; } @@ -108698,15 +125430,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/models:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -108720,65 +125455,209 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Copy extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CopyModelRequest; + } + export interface Params$Resource$Projects$Locations$Models$Delete extends StandardParameters { + /** + * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Deleteversion extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Export extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportModelRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Get extends StandardParameters { /** - * The standard list filter. + * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$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$Locations$Models$List extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Models$Listcheckpoints extends StandardParameters { + /** + * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. + */ + name?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Models$Listversions extends StandardParameters { + /** + * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` + */ + filter?: string; + /** + * Required. The name of the model to list versions for. */ name?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. + */ + orderBy?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Mask specifying which fields to read. */ - returnPartialSuccess?: boolean; + readMask?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Executions$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1MergeVersionAliasesRequest; + } + export interface Params$Resource$Projects$Locations$Models$Patch extends StandardParameters { + /** + * Identifier. The resource name of the Model. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Model; } + export interface Params$Resource$Projects$Locations$Models$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; - export class Resource$Projects$Locations$Metadatastores$Metadataschemas { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Models$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset extends StandardParameters { + /** + * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpdateExplanationDatasetRequest; + } + export interface Params$Resource$Projects$Locations$Models$Upload extends StandardParameters { + /** + * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UploadModelRequest; + } + + export class Resource$Projects$Locations$Models$Evaluations { context: APIRequestContext; + operations: Resource$Projects$Locations$Models$Evaluations$Operations; + slices: Resource$Projects$Locations$Models$Evaluations$Slices; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Models$Evaluations$Operations( + this.context + ); + this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( + this.context + ); } /** - * Creates a MetadataSchema. + * Gets a ModelEvaluation. * @example * ```js * // Before running the sample: @@ -108807,37 +125686,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.create({ - * // The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) - * metadataSchemaId: 'placeholder-value', - * // Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.models.evaluations.get({ + * // Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * }); * console.log(res.data); * * // Example response * // { + * // "annotationSchemaUri": "my_annotationSchemaUri", * // "createTime": "my_createTime", - * // "description": "my_description", + * // "dataItemSchemaUri": "my_dataItemSchemaUri", + * // "displayName": "my_displayName", + * // "explanationSpecs": [], + * // "metadata": {}, + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" + * // "sliceDimensions": [] * // } * } * @@ -108853,62 +125720,62 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Metadataschemas$Create, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Get + | 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$Metadatastores$Metadataschemas$Create; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; options = {}; } @@ -108921,34 +125788,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Retrieves a specific MetadataSchema. + * Imports an externally generated ModelEvaluation. * @example * ```js * // Before running the sample: @@ -108977,21 +125841,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.get({ - * // Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/metadataSchemas/my-metadataSchema', - * }); + * const res = await aiplatform.projects.locations.models.evaluations.import({ + * // Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * parent: 'projects/my-project/locations/my-location/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "modelEvaluation": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { + * // "annotationSchemaUri": "my_annotationSchemaUri", * // "createTime": "my_createTime", - * // "description": "my_description", + * // "dataItemSchemaUri": "my_dataItemSchemaUri", + * // "displayName": "my_displayName", + * // "explanationSpecs": [], + * // "metadata": {}, + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, * // "name": "my_name", - * // "schema": "my_schema", - * // "schemaType": "my_schemaType", - * // "schemaVersion": "my_schemaVersion" + * // "sliceDimensions": [] * // } * } * @@ -109007,62 +125883,62 @@ export namespace aiplatform_v1 { * @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$Metadatastores$Metadataschemas$Get, + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + import( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$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$Metadatastores$Metadataschemas$Get; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; options = {}; } @@ -109075,31 +125951,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/evaluations:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, 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 ); } } /** - * Lists MetadataSchemas. + * Lists ModelEvaluations in a Model. * @example * ```js * // Before running the sample: @@ -109128,23 +126007,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.metadataStores.metadataSchemas.list({ - * // A query to filter available MetadataSchemas for matching results. - * filter: 'placeholder-value', - * // The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) - * pageToken: 'placeholder-value', - * // Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` - * parent: - * 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', - * }); + * const res = await aiplatform.projects.locations.models.evaluations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * parent: 'projects/my-project/locations/my-location/models/my-model', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "metadataSchemas": [], + * // "modelEvaluations": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -109162,61 +126041,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params?: Params$Resource$Projects$Locations$Models$Evaluations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Models$Evaluations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$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$Metadatastores$Metadataschemas$List; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List; + {} as Params$Resource$Projects$Locations$Models$Evaluations$List; options = {}; } @@ -109229,7 +126108,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/metadataSchemas').replace( + url: (rootUrl + '/v1/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), @@ -109244,59 +126123,59 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Get extends StandardParameters { /** - * The {metadata_schema\} portion of the resource name with the format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` If not provided, the MetadataStore's ID will be a UUID generated by the service. Must be 4-128 characters in length. Valid characters are `/a-z-/`. Must be unique across all MetadataSchemas in the parent Location. (Otherwise the request will fail with ALREADY_EXISTS, or PERMISSION_DENIED if the caller can't view the preexisting MetadataSchema.) + * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` */ - metadataSchemaId?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Import extends StandardParameters { /** - * Required. The resource name of the MetadataStore where the MetadataSchema should be created. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1MetadataSchema; - } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$Get extends StandardParameters { - /** - * Required. The resource name of the MetadataSchema to retrieve. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}/metadataSchemas/{metadataschema\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1ImportModelEvaluationRequest; } - export interface Params$Resource$Projects$Locations$Metadatastores$Metadataschemas$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$List extends StandardParameters { /** - * A query to filter available MetadataSchemas for matching results. + * The standard list filter. */ filter?: string; /** - * The maximum number of MetadataSchemas to return. The service may return fewer. Must be in range 1-100, inclusive. Defaults to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous MetadataService.ListMetadataSchemas call. Provide this to retrieve the next page. When paginating, all other provided parameters must match the call that provided the page token. (Otherwise the request will fail with INVALID_ARGUMENT error.) + * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. */ pageToken?: string; /** - * Required. The MetadataStore whose MetadataSchemas should be listed. Format: `projects/{project\}/locations/{location\}/metadataStores/{metadatastore\}` + * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` */ parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; } - export class Resource$Projects$Locations$Metadatastores$Operations { + export class Resource$Projects$Locations$Models$Evaluations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -109333,9 +126212,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.cancel({ + * await aiplatform.projects.locations.models.evaluations.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -109356,31 +126235,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109396,13 +126275,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; options = {}; } @@ -109467,9 +126346,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.delete({ + * await aiplatform.projects.locations.models.evaluations.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', * }); * console.log(res.data); * @@ -109490,31 +126369,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Delete + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109530,13 +126409,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Delete; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; options = {}; } @@ -109600,12 +126479,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.metadataStores.operations.get( - * { + * const res = + * await aiplatform.projects.locations.models.evaluations.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', - * }, - * ); + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -109631,27 +126509,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -109659,7 +126536,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Get + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109675,13 +126552,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; options = {}; } @@ -109746,11 +126623,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.list({ + * await aiplatform.projects.locations.models.evaluations.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore', + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -109781,29 +126658,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$List, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, callback: BodyResponseCallback ): void; list( @@ -109811,7 +126688,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$List + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109829,13 +126706,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$List; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; options = {}; } @@ -109905,9 +126782,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.metadataStores.operations.wait({ + * await aiplatform.projects.locations.models.evaluations.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/metadataStores/my-metadataStore/operations/my-operation', + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -109936,27 +126813,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Metadatastores$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -109964,7 +126840,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Metadatastores$Operations$Wait + | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -109980,13 +126856,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Metadatastores$Operations$Wait; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; options = {}; } @@ -110021,25 +126897,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -110061,7 +126937,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Metadatastores$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -110072,19 +126948,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Migratableresources { + export class Resource$Projects$Locations$Models$Evaluations$Slices { context: APIRequestContext; - operations: Resource$Projects$Locations$Migratableresources$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Migratableresources$Operations( - this.context - ); } /** - * Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI. + * Imports a list of externally generated EvaluatedAnnotations. * @example * ```js * // Before running the sample: @@ -110114,15 +126985,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.migratableResources.batchMigrate({ - * // Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * await aiplatform.projects.locations.models.evaluations.slices.batchImport({ + * // Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * parent: + * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "migrateResourceRequests": [] + * // "evaluatedAnnotations": [] * // } * }, * }); @@ -110130,11 +127002,7 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "importedEvaluatedAnnotationsCount": 0 * // } * } * @@ -110150,58 +127018,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: StreamMethodOptions ): Promise>; - batchMigrate( - params?: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + batchImport( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options?: MethodOptions - ): Promise>; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchMigrate( - params: Params$Resource$Projects$Locations$Migratableresources$Batchmigrate, - callback: BodyResponseCallback + batchImport( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + callback: BodyResponseCallback ): void; - batchMigrate( - callback: BodyResponseCallback + batchImport( + callback: BodyResponseCallback ): void; - batchMigrate( + batchImport( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Batchmigrate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Batchmigrate; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; options = {}; } @@ -110214,9 +127086,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/migratableResources:batchMigrate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}:batchImport').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -110228,17 +127101,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location. + * Gets a ModelEvaluationSlice. * @example * ```js * // Before running the sample: @@ -110267,25 +127142,177 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.migratableResources.search({ - * // Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "pageSize": 0, - * // "pageToken": "my_pageToken" - * // } + * const res = await aiplatform.projects.locations.models.evaluations.slices.get( + * { + * // Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', * }, + * ); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "metrics": {}, + * // "metricsSchemaUri": "my_metricsSchemaUri", + * // "modelExplanation": {}, + * // "name": "my_name", + * // "slice": {} + * // } + * } + * + * 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$Models$Evaluations$Slices$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 ModelEvaluationSlices in a ModelEvaluation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.models.evaluations.slices.list({ + * // The standard list filter. * `slice.dimension` - for =. + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * parent: + * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "migratableResources": [], + * // "modelEvaluationSlices": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -110302,62 +127329,62 @@ export namespace aiplatform_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$Migratableresources$Search, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: StreamMethodOptions ): Promise>; - search( - params?: Params$Resource$Projects$Locations$Migratableresources$Search, + list( + params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Migratableresources$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Models$Evaluations$Slices$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$Migratableresources$Search; + {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Search; + {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; options = {}; } @@ -110370,11 +127397,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/migratableResources:search').replace( + url: (rootUrl + '/v1/{+parent}/slices').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -110385,42 +127412,59 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Migratableresources$Batchmigrate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport extends StandardParameters { /** - * Required. The location of the migrated resource will live in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchMigrateResourcesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest; } - export interface Params$Resource$Projects$Locations$Migratableresources$Search extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get extends StandardParameters { /** - * Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List extends StandardParameters { + /** + * The standard list filter. * `slice.dimension` - for =. + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. + */ + pageToken?: string; + /** + * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` */ parent?: string; - /** - * Request body metadata + * Mask specifying which fields to read. */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchMigratableResourcesRequest; + readMask?: string; } - export class Resource$Projects$Locations$Migratableresources$Operations { + export class Resource$Projects$Locations$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -110456,11 +127500,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.models.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -110480,31 +127523,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel, + params: Params$Resource$Projects$Locations$Models$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel + | Params$Resource$Projects$Locations$Models$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110520,13 +127563,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Models$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; options = {}; } @@ -110590,11 +127633,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.models.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -110614,31 +127656,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params?: Params$Resource$Projects$Locations$Models$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Delete, + params: Params$Resource$Projects$Locations$Models$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Delete + | Params$Resource$Projects$Locations$Models$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110654,13 +127696,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Models$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Delete; + {} as Params$Resource$Projects$Locations$Models$Operations$Delete; options = {}; } @@ -110724,11 +127766,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.models.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -110754,27 +127795,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params?: Params$Resource$Projects$Locations$Models$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Get, + params: Params$Resource$Projects$Locations$Models$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -110782,7 +127822,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Get + | Params$Resource$Projects$Locations$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110798,13 +127838,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; options = {}; } @@ -110868,19 +127907,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.models.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/models/my-model', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -110904,29 +127942,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Models$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params?: Params$Resource$Projects$Locations$Models$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Models$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$List, + params: Params$Resource$Projects$Locations$Models$Operations$List, callback: BodyResponseCallback ): void; list( @@ -110934,7 +127972,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$List + | Params$Resource$Projects$Locations$Models$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -110952,13 +127990,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$List; + {} as Params$Resource$Projects$Locations$Models$Operations$List; options = {}; } @@ -111027,13 +128065,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.migratableResources.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/migratableResources/my-migratableResource/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.models.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -111059,27 +128096,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params?: Params$Resource$Projects$Locations$Models$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Migratableresources$Operations$Wait, + params: Params$Resource$Projects$Locations$Models$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -111087,7 +128123,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Migratableresources$Operations$Wait + | Params$Resource$Projects$Locations$Models$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -111103,13 +128139,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Migratableresources$Operations$Wait; + {} as Params$Resource$Projects$Locations$Models$Operations$Wait; options = {}; } @@ -111144,25 +128180,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -111184,7 +128220,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Migratableresources$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Models$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -111195,19 +128231,155 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs { + export class Resource$Projects$Locations$Nasjobs { context: APIRequestContext; - operations: Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations; + nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations( - this.context + this.nasTrialDetails = + new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); + } + + /** + * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.nasJobs.cancel({ + * // Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * console.log(res.data); + * + * // Example 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. + */ + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: StreamMethodOptions + ): Promise>; + cancel( + params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options?: MethodOptions + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').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); + } } /** - * Creates a ModelDeploymentMonitoringJob. It will run periodically on a configured interval. + * Creates a NasJob * @example * ```js * // Before running the sample: @@ -111236,71 +128408,50 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.create({ - * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.nasJobs.create({ + * // Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", - * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, - * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "enableRestrictedImageTraining": false, + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, + * // "enableRestrictedImageTraining": false, * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", + * // "endTime": "my_endTime", * // "error": {}, * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", + * // "startTime": "my_startTime", * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * } @@ -111318,61 +128469,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params?: Params$Resource$Projects$Locations$Nasjobs$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, + params: Params$Resource$Projects$Locations$Nasjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Nasjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + {}) as Params$Resource$Projects$Locations$Nasjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Create; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; options = {}; } @@ -111385,9 +128531,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/nasJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -111399,19 +128546,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a ModelDeploymentMonitoringJob. + * Deletes a NasJob. * @example * ```js * // Before running the sample: @@ -111440,11 +128587,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.delete({ - * // Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * }); + * const res = await aiplatform.projects.locations.nasJobs.delete({ + * // Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response @@ -111470,27 +128616,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + params?: Params$Resource$Projects$Locations$Nasjobs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Nasjobs$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete, + params: Params$Resource$Projects$Locations$Nasjobs$Delete, callback: BodyResponseCallback ): void; delete( @@ -111498,7 +128643,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete + | Params$Resource$Projects$Locations$Nasjobs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -111514,13 +128659,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; options = {}; } @@ -111555,7 +128699,7 @@ export namespace aiplatform_v1 { } /** - * Gets a ModelDeploymentMonitoringJob. + * Gets a NasJob * @example * ```js * // Before running the sample: @@ -111576,7 +128720,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -111584,39 +128731,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.get({ - * // Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * }); + * const res = await aiplatform.projects.locations.nasJobs.get({ + * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], * // "createTime": "my_createTime", * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, + * // "enableRestrictedImageTraining": false, * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", + * // "endTime": "my_endTime", * // "error": {}, * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, + * // "nasJobOutput": {}, + * // "nasJobSpec": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", + * // "startTime": "my_startTime", * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, * // "updateTime": "my_updateTime" * // } * } @@ -111634,61 +128770,424 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + params?: Params$Resource$Projects$Locations$Nasjobs$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 NasJobs in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.nasJobs.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nasJobs": [], + * // "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$Nasjobs$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Nasjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/nasJobs').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 + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Cancel extends StandardParameters { + /** + * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NasJob; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Delete extends StandardParameters { + /** + * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Get extends StandardParameters { + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$List extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a NasTrialDetail. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.nasJobs.nasTrialDetails.get({ + * // Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob/nasTrialDetails/my-nasTrialDetail', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "name": "my_name", + * // "parameters": "my_parameters", + * // "searchTrial": {}, + * // "trainTrial": {} + * // } + * } + * + * 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$Nasjobs$Nastrialdetails$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + | 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$Modeldeploymentmonitoringjobs$Get; + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get; + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; options = {}; } @@ -111713,19 +129212,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists ModelDeploymentMonitoringJobs in a Location. + * List top NasTrialDetails of a NasJob. * @example * ```js * // Before running the sample: @@ -111754,24 +129253,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.list({ + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + * pageToken: 'placeholder-value', + * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * parent: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', + * }); * console.log(res.data); * * // Example response * // { - * // "modelDeploymentMonitoringJobs": [], + * // "nasTrialDetails": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -111789,61 +129283,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$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$Modeldeploymentmonitoringjobs$List; + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List; + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; options = {}; } @@ -111856,9 +129350,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/modelDeploymentMonitoringJobs' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -111870,19 +129365,52 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get extends StandardParameters { + /** + * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List extends StandardParameters { + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + */ + pageToken?: string; + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Notebookexecutionjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookexecutionjobs$Operations( + this.context + ); + } /** - * Updates a ModelDeploymentMonitoringJob. + * Creates a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -111905,51 +129433,45 @@ export namespace aiplatform_v1 { * // 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 aiplatform.projects.locations.modelDeploymentMonitoringJobs.patch({ - * // Output only. Resource name of a ModelDeploymentMonitoringJob. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * // Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "analysisInstanceSchemaUri": "my_analysisInstanceSchemaUri", - * // "bigqueryTables": [], - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableMonitoringPipelineLogs": false, - * // "encryptionSpec": {}, - * // "endpoint": "my_endpoint", - * // "error": {}, - * // "labels": {}, - * // "latestMonitoringPipelineMetadata": {}, - * // "logTtl": "my_logTtl", - * // "loggingSamplingStrategy": {}, - * // "modelDeploymentMonitoringObjectiveConfigs": [], - * // "modelDeploymentMonitoringScheduleConfig": {}, - * // "modelMonitoringAlertConfig": {}, - * // "name": "my_name", - * // "nextScheduleTime": "my_nextScheduleTime", - * // "predictInstanceSchemaUri": "my_predictInstanceSchemaUri", - * // "samplePredictInstance": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "scheduleState": "my_scheduleState", - * // "state": "my_state", - * // "statsAnomaliesBaseDirectory": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * + * // 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 aiplatform.projects.locations.notebookExecutionJobs.create({ + * // Optional. User specified ID for the NotebookExecutionJob. + * notebookExecutionJobId: 'placeholder-value', + * // Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "customEnvironmentSpec": {}, + * // "dataformRepositorySource": {}, + * // "directNotebookSource": {}, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "executionTimeout": "my_executionTimeout", + * // "executionUser": "my_executionUser", + * // "gcsNotebookSource": {}, + * // "gcsOutputUri": "my_gcsOutputUri", + * // "jobState": "my_jobState", + * // "kernelName": "my_kernelName", + * // "labels": {}, + * // "name": "my_name", + * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", + * // "scheduleResourceName": "my_scheduleResourceName", + * // "serviceAccount": "my_serviceAccount", + * // "status": {}, + * // "updateTime": "my_updateTime", + * // "workbenchRuntime": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -111974,36 +129496,35 @@ export namespace aiplatform_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$Modeldeploymentmonitoringjobs$Patch, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + create( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch, + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112019,13 +129540,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; options = {}; } @@ -112038,15 +129559,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -112060,7 +129584,7 @@ export namespace aiplatform_v1 { } /** - * Pauses a ModelDeploymentMonitoringJob. If the job is running, the server makes a best effort to cancel the job. Will mark ModelDeploymentMonitoringJob.state to 'PAUSED'. + * Deletes a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -112089,21 +129613,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.pause({ - * // Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.delete({ + * // Required. The name of the NotebookExecutionJob resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -112118,54 +129641,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + delete( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + callback: BodyResponseCallback ): void; - pause(callback: BodyResponseCallback): void; - pause( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; options = {}; } @@ -112178,8 +129704,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -112190,17 +129716,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Resumes a paused ModelDeploymentMonitoringJob. It will start to run from next scheduled time. A deleted ModelDeploymentMonitoringJob can't be resumed. + * Gets a NotebookExecutionJob. * @example * ```js * // Before running the sample: @@ -112229,21 +129755,37 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.resume({ - * // Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.get({ + * // Required. The name of the NotebookExecutionJob resource. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * // Optional. The NotebookExecutionJob view. Defaults to BASIC. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "customEnvironmentSpec": {}, + * // "dataformRepositorySource": {}, + * // "directNotebookSource": {}, + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "executionTimeout": "my_executionTimeout", + * // "executionUser": "my_executionUser", + * // "gcsNotebookSource": {}, + * // "gcsOutputUri": "my_gcsOutputUri", + * // "jobState": "my_jobState", + * // "kernelName": "my_kernelName", + * // "labels": {}, + * // "name": "my_name", + * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", + * // "scheduleResourceName": "my_scheduleResourceName", + * // "serviceAccount": "my_serviceAccount", + * // "status": {}, + * // "updateTime": "my_updateTime", + * // "workbenchRuntime": {} + * // } * } * * main().catch(e => { @@ -112258,54 +129800,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + get( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + callback: BodyResponseCallback ): void; - resume(callback: BodyResponseCallback): void; - resume( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; options = {}; } @@ -112318,8 +129868,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -112330,17 +129880,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Searches Model Monitoring Statistics generated within a given time window. + * Lists NotebookExecutionJobs in a Location. * @example * ```js * // Before running the sample: @@ -112369,34 +129921,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.searchModelDeploymentMonitoringStatsAnomalies( - * { - * // Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - * modelDeploymentMonitoringJob: - * 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deployedModelId": "my_deployedModelId", - * // "endTime": "my_endTime", - * // "featureDisplayName": "my_featureDisplayName", - * // "objectives": [], - * // "pageSize": 0, - * // "pageToken": "my_pageToken", - * // "startTime": "my_startTime" - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.notebookExecutionJobs.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. The NotebookExecutionJob view. Defaults to BASIC. + * view: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "monitoringStats": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "notebookExecutionJobs": [] * // } * } * @@ -112412,62 +129956,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions ): Promise>; - searchModelDeploymentMonitoringStatsAnomalies( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + list( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - searchModelDeploymentMonitoringStatsAnomalies( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$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$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; options = {}; } @@ -112480,128 +130024,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+modelDeploymentMonitoringJob}:searchModelDeploymentMonitoringStatsAnomalies' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['modelDeploymentMonitoringJob'], - pathParams: ['modelDeploymentMonitoringJob'], + 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$Modeldeploymentmonitoringjobs$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create extends StandardParameters { /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` + * Optional. User specified ID for the NotebookExecutionJob. + */ + notebookExecutionJobId?: string; + /** + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Delete extends StandardParameters { - /** - * Required. The resource name of the model monitoring job to delete. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete extends StandardParameters { /** - * Required. The resource name of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Required. The name of the NotebookExecutionJob resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$List extends StandardParameters { - /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - /** - * Required. The parent of the ModelDeploymentMonitoringJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get extends StandardParameters { /** - * Output only. Resource name of a ModelDeploymentMonitoringJob. + * Required. The name of the NotebookExecutionJob resource. */ name?: string; /** - * Required. The update mask is used to specify the fields to be overwritten in the ModelDeploymentMonitoringJob resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. For the objective config, the user can either provide the update mask for model_deployment_monitoring_objective_configs or any combination of its nested fields, such as: model_deployment_monitoring_objective_configs.objective_config.training_dataset. Updatable fields: * `display_name` * `model_deployment_monitoring_schedule_config` * `model_monitoring_alert_config` * `logging_sampling_strategy` * `labels` * `log_ttl` * `enable_monitoring_pipeline_logs` . and * `model_deployment_monitoring_objective_configs` . or * `model_deployment_monitoring_objective_configs.objective_config.training_dataset` * `model_deployment_monitoring_objective_configs.objective_config.training_prediction_skew_detection_config` * `model_deployment_monitoring_objective_configs.objective_config.prediction_drift_detection_config` - */ - updateMask?: string; - - /** - * Request body metadata + * Optional. The NotebookExecutionJob view. Defaults to BASIC. */ - requestBody?: Schema$GoogleCloudAiplatformV1ModelDeploymentMonitoringJob; + view?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Pause extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List extends StandardParameters { /** - * Required. The resource name of the ModelDeploymentMonitoringJob to pause. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` */ - name?: string; - + filter?: string; /** - * Request body metadata + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. */ - requestBody?: Schema$GoogleCloudAiplatformV1PauseModelDeploymentMonitoringJobRequest; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Resume extends StandardParameters { + orderBy?: string; /** - * Required. The resource name of the ModelDeploymentMonitoringJob to resume. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Optional. The standard list page size. */ - name?: string; - + pageSize?: number; /** - * Request body metadata + * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. */ - requestBody?: Schema$GoogleCloudAiplatformV1ResumeModelDeploymentMonitoringJobRequest; - } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Searchmodeldeploymentmonitoringstatsanomalies extends StandardParameters { + pageToken?: string; /** - * Required. ModelDeploymentMonitoring Job resource name. Format: `projects/{project\}/locations/{location\}/modelDeploymentMonitoringJobs/{model_deployment_monitoring_job\}` + * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` */ - modelDeploymentMonitoringJob?: string; - + parent?: string; /** - * Request body metadata + * Optional. The NotebookExecutionJob view. Defaults to BASIC. */ - requestBody?: Schema$GoogleCloudAiplatformV1SearchModelDeploymentMonitoringStatsAnomaliesRequest; + view?: string; } - export class Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations { + export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -112638,10 +130146,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.cancel( + * await aiplatform.projects.locations.notebookExecutionJobs.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }, * ); * console.log(res.data); @@ -112663,31 +130171,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112703,13 +130211,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; options = {}; } @@ -112774,10 +130282,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.delete( + * await aiplatform.projects.locations.notebookExecutionJobs.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', * }, * ); * console.log(res.data); @@ -112799,31 +130307,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112839,13 +130347,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; options = {}; } @@ -112910,12 +130418,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * }, - * ); + * await aiplatform.projects.locations.notebookExecutionJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -112941,27 +130447,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -112969,7 +130474,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -112985,13 +130490,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; options = {}; } @@ -113056,20 +130561,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.notebookExecutionJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -113093,29 +130596,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -113123,7 +130626,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113141,13 +130644,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; options = {}; } @@ -113217,14 +130720,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.modelDeploymentMonitoringJobs.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/modelDeploymentMonitoringJobs/my-modelDeploymentMonitoringJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.notebookExecutionJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -113250,27 +130751,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -113278,7 +130778,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113294,13 +130794,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; options = {}; } @@ -113335,25 +130835,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -113375,7 +130875,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Modeldeploymentmonitoringjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -113386,22 +130886,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Models { + export class Resource$Projects$Locations$Notebookruntimes { context: APIRequestContext; - evaluations: Resource$Projects$Locations$Models$Evaluations; - operations: Resource$Projects$Locations$Models$Operations; + operations: Resource$Projects$Locations$Notebookruntimes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.evaluations = new Resource$Projects$Locations$Models$Evaluations( - this.context - ); - this.operations = new Resource$Projects$Locations$Models$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Notebookruntimes$Operations( + this.context + ); } /** - * Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for Model.metadata content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible. + * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. * @example * ```js * // Before running the sample: @@ -113430,19 +130927,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.copy({ - * // Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.notebookRuntimes.assign({ + * // Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "customServiceAccount": "my_customServiceAccount", - * // "encryptionSpec": {}, - * // "modelId": "my_modelId", - * // "parentModel": "my_parentModel", - * // "sourceModel": "my_sourceModel" + * // "notebookRuntime": {}, + * // "notebookRuntimeId": "my_notebookRuntimeId", + * // "notebookRuntimeTemplate": "my_notebookRuntimeTemplate" * // } * }, * }); @@ -113470,36 +130965,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions ): Promise>; - copy( - params?: Params$Resource$Projects$Locations$Models$Copy, + assign( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options?: MethodOptions ): Promise>; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - copy( - params: Params$Resource$Projects$Locations$Models$Copy, + assign( + params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, callback: BodyResponseCallback ): void; - copy( + assign( callback: BodyResponseCallback ): void; - copy( + assign( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Copy + | Params$Resource$Projects$Locations$Notebookruntimes$Assign | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113515,12 +131009,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Copy; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Copy; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; options = {}; } @@ -113533,7 +131028,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models:copy').replace( + url: (rootUrl + '/v1/{+parent}/notebookRuntimes:assign').replace( /([^:]\/)\/+/g, '$1' ), @@ -113558,7 +131053,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field. + * Deletes a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -113587,9 +131082,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.delete({ - * // Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * name: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.notebookRuntimes.delete({ + * // Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', * }); * console.log(res.data); * @@ -113616,56 +131111,380 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Models$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Models$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Models$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 a NotebookRuntime. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.notebookRuntimes.get({ + * // Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "eucConfig": {}, + * // "expirationTime": "my_expirationTime", + * // "healthState": "my_healthState", + * // "idleShutdownConfig": {}, + * // "isUpgradable": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeTemplateRef": {}, + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "proxyUri": "my_proxyUri", + * // "reservationAffinity": {}, + * // "runtimeState": "my_runtimeState", + * // "runtimeUser": "my_runtimeUser", + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime", + * // "version": "my_version" + * // } + * } + * + * 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$Notebookruntimes$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookruntimes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 NotebookRuntimes in a Location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.notebookRuntimes.list({ + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "notebookRuntimes": [] + * // } + * } + * + * 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$Notebookruntimes$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Notebookruntimes$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Delete; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; options = {}; } @@ -113678,29 +131497,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/notebookRuntimes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Model version. Model version can only be deleted if there are no DeployedModels created from it. Deleting the only version in the Model is not allowed. Use DeleteModel for deleting the Model instead. + * Starts a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -113729,9 +131553,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.deleteVersion({ - * // Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - * name: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.notebookRuntimes.start({ + * // Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -113757,36 +131587,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions ): Promise>; - deleteVersion( - params?: Params$Resource$Projects$Locations$Models$Deleteversion, + start( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, options?: MethodOptions ): Promise>; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteVersion( - params: Params$Resource$Projects$Locations$Models$Deleteversion, + start( + params: Params$Resource$Projects$Locations$Notebookruntimes$Start, callback: BodyResponseCallback ): void; - deleteVersion( + start( callback: BodyResponseCallback ): void; - deleteVersion( + start( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Deleteversion + | Params$Resource$Projects$Locations$Notebookruntimes$Start | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113802,12 +131631,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Deleteversion; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Deleteversion; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; options = {}; } @@ -113820,11 +131650,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:deleteVersion').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -113845,7 +131672,7 @@ export namespace aiplatform_v1 { } /** - * Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one supported export format. + * Stops a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -113874,16 +131701,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.export({ - * // Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. - * name: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.notebookRuntimes.stop({ + * // Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', * * // Request body metadata * requestBody: { * // request body parameters - * // { - * // "outputConfig": {} - * // } + * // {} * }, * }); * console.log(res.data); @@ -113910,36 +131735,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - export( - params: Params$Resource$Projects$Locations$Models$Export, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions ): Promise>; - export( - params?: Params$Resource$Projects$Locations$Models$Export, + stop( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options?: MethodOptions ): Promise>; - export( - params: Params$Resource$Projects$Locations$Models$Export, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - export( - params: Params$Resource$Projects$Locations$Models$Export, + stop( + params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, callback: BodyResponseCallback ): void; - export( + stop( callback: BodyResponseCallback ): void; - export( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Export + | Params$Resource$Projects$Locations$Notebookruntimes$Stop | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -113955,12 +131779,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Export; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Export; + params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; options = {}; } @@ -113973,7 +131797,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:export').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -113995,7 +131819,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Model. + * Upgrades a NotebookRuntime. * @example * ```js * // Before running the sample: @@ -114024,49 +131848,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.get({ - * // Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. - * name: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.notebookRuntimes.upgrade({ + * // Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "response": {} * // } * } * @@ -114082,57 +131882,57 @@ export namespace aiplatform_v1 { * @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$Models$Get, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Get, + upgrade( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Models$Get, + ): Promise>; + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Get, + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Get, - callback: BodyResponseCallback + upgrade( + params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + upgrade( + callback: BodyResponseCallback ): void; - get( + upgrade( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Get; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; options = {}; } @@ -114145,8 +131945,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -114157,19 +131960,107 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AssignNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Get extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Start extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StartNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StopNotebookRuntimeRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade extends StandardParameters { + /** + * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest; + } + + export class Resource$Projects$Locations$Notebookruntimes$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -114198,20 +132089,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.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/locations/my-location/models/my-model', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimes.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 - * // } + * // {} * } * * main().catch(e => { @@ -114226,55 +132112,54 @@ export namespace aiplatform_v1 { * @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$Locations$Models$Getiampolicy, + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Getiampolicy, + cancel( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Models$Getiampolicy, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + callback: BodyResponseCallback ): void; - getIamPolicy( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; options = {}; } @@ -114287,32 +132172,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Models in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -114341,27 +132223,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.list({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimes.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "models": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // {} * } * * main().catch(e => { @@ -114376,61 +132246,54 @@ export namespace aiplatform_v1 { * @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$Models$List, + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$List, + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Models$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$List; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; options = {}; } @@ -114443,34 +132306,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists checkpoints of the specified model version. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -114499,20 +132357,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.listCheckpoints({ - * // Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. - * pageToken: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimes.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "checkpoints": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -114528,62 +132386,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions ): Promise>; - listCheckpoints( - params?: Params$Resource$Projects$Locations$Models$Listcheckpoints, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listCheckpoints( - params: Params$Resource$Projects$Locations$Models$Listcheckpoints, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + callback: BodyResponseCallback ): void; - listCheckpoints( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - listCheckpoints( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listcheckpoints - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Listcheckpoints; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Listcheckpoints; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; options = {}; } @@ -114596,10 +132449,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listCheckpoints').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -114611,19 +132461,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists versions of the specified model. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -114652,26 +132500,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.listVersions({ - * // An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` - * filter: 'placeholder-value', - * // Required. The name of the model to list versions for. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. - * pageToken: 'placeholder-value', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimes.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "models": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -114687,61 +132535,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions ): Promise>; - listVersions( - params?: Params$Resource$Projects$Locations$Models$Listversions, + list( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listVersions( - params: Params$Resource$Projects$Locations$Models$Listversions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + callback: BodyResponseCallback ): void; - listVersions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - listVersions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Listversions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$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$Models$Listversions; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Listversions; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; options = {}; } @@ -114754,7 +132603,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:listVersions').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -114769,19 +132618,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Merges a set of aliases for a Model version. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -114810,57 +132659,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.mergeVersionAliases({ - * // Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - * name: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "versionAliases": [] - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimes.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "response": {} * // } * } * @@ -114876,58 +132690,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions ): Promise>; - mergeVersionAliases( - params?: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + wait( + params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options?: MethodOptions - ): Promise>; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - params: Params$Resource$Projects$Locations$Models$Mergeversionaliases, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + callback: BodyResponseCallback ): void; - mergeVersionAliases( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - mergeVersionAliases( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Mergeversionaliases - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Mergeversionaliases; + {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Mergeversionaliases; + {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; options = {}; } @@ -114940,10 +132753,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:mergeVersionAliases').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -114955,19 +132765,80 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel extends StandardParameters { /** - * Updates a Model. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Notebookruntimetemplates { + context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookruntimetemplates$Operations( + this.context + ); + } + + /** + * Creates a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -114996,93 +132867,49 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.patch({ - * // Identifier. The resource name of the Model. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.create({ + * // Optional. User specified ID for the notebook runtime template. + * notebookRuntimeTemplateId: 'placeholder-value', + * // Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, - * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, - * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "artifactUri": "my_artifactUri", - * // "baseModelSource": {}, - * // "checkpoints": [], - * // "containerSpec": {}, - * // "createTime": "my_createTime", - * // "dataStats": {}, - * // "defaultCheckpointId": "my_defaultCheckpointId", - * // "deployedModels": [], - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "explanationSpec": {}, - * // "labels": {}, + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "metadataArtifact": "my_metadataArtifact", - * // "metadataSchemaUri": "my_metadataSchemaUri", - * // "modelSourceInfo": {}, * // "name": "my_name", - * // "originalModelInfo": {}, - * // "pipelineJob": "my_pipelineJob", - * // "predictSchemata": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "supportedDeploymentResourcesTypes": [], - * // "supportedExportFormats": [], - * // "supportedInputStorageFormats": [], - * // "supportedOutputStorageFormats": [], - * // "trainingPipeline": "my_trainingPipeline", - * // "updateTime": "my_updateTime", - * // "versionAliases": [], - * // "versionCreateTime": "my_versionCreateTime", - * // "versionDescription": "my_versionDescription", - * // "versionId": "my_versionId", - * // "versionUpdateTime": "my_versionUpdateTime" + * // "response": {} * // } * } * @@ -115098,57 +132925,57 @@ export namespace aiplatform_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$Models$Patch, + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Models$Patch, + create( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, + ): void; + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Models$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Patch; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Patch; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; options = {}; } @@ -115161,31 +132988,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Deletes a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -115214,25 +133042,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.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/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.delete({ + * // Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -115248,55 +133071,57 @@ export namespace aiplatform_v1 { * @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$Locations$Models$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Models$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Models$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - setIamPolicy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; options = {}; } @@ -115309,32 +133134,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Gets a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -115363,17 +133185,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: 'projects/my-project/locations/my-location/models/my-model', + * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.get({ + * // Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', * }); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -115389,62 +133228,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Models$Testiampermissions, + get( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Models$Testiampermissions, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - testIamPermissions( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Get + | 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$Models$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Testiampermissions; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; options = {}; } @@ -115457,34 +133296,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Incrementally update the dataset used for an examples model. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -115514,27 +133350,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.updateExplanationDataset({ - * // Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * model: 'projects/my-project/locations/my-location/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "examples": {} - * // } - * }, + * await aiplatform.projects.locations.notebookRuntimeTemplates.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/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -115550,58 +133379,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions ): Promise>; - updateExplanationDataset( - params?: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options?: MethodOptions - ): Promise>; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateExplanationDataset( - params: Params$Resource$Projects$Locations$Models$Updateexplanationdataset, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + callback: BodyResponseCallback ): void; - updateExplanationDataset( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - updateExplanationDataset( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Updateexplanationdataset - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Updateexplanationdataset; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; options = {}; } @@ -115614,7 +133441,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:updateExplanationDataset').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -115624,22 +133451,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Uploads a Model artifact into Vertex AI. + * Lists NotebookRuntimeTemplates in a Location. * @example * ```js * // Before running the sample: @@ -115668,30 +133495,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.upload({ - * // Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "model": {}, - * // "modelId": "my_modelId", - * // "parentModel": "my_parentModel", - * // "serviceAccount": "my_serviceAccount" - * // } + * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.list( + * { + * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Optional. Mask specifying which fields to read. + * readMask: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "notebookRuntimeTemplates": [] * // } * } * @@ -115707,57 +133532,62 @@ export namespace aiplatform_v1 { * @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$Projects$Locations$Models$Upload, + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions ): Promise>; - upload( - params?: Params$Resource$Projects$Locations$Models$Upload, + list( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options?: MethodOptions - ): Promise>; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Models$Upload, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - upload( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Upload; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Upload; + params = + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; options = {}; } @@ -115770,11 +133600,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/models:upload').replace( + url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -115785,219 +133615,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Models$Copy extends StandardParameters { - /** - * Required. The resource name of the Location into which to copy the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CopyModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Delete extends StandardParameters { - /** - * Required. The name of the Model resource to be deleted. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Deleteversion extends StandardParameters { - /** - * Required. The name of the model version to be deleted, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Export extends StandardParameters { - /** - * Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportModelRequest; - } - export interface Params$Resource$Projects$Locations$Models$Get extends StandardParameters { - /** - * Required. The name of the Model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$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$Locations$Models$List extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `model` supports = and !=. `model` represents the Model ID, i.e. the last segment of the Model's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `base_model_name` only supports = Some examples: * `model=1234` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `baseModelName="text-bison"` - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelsResponse.next_page_token of the previous ModelService.ListModels call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the Models from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Models$Listcheckpoints extends StandardParameters { - /** - * Required. The name of the model version to list checkpoints for. `projects/{project\}/locations/{location\}/models/{model\}@{version\}` Example: `projects/{project\}/locations/{location\}/models/{model\}@2` or `projects/{project\}/locations/{location\}/models/{model\}@golden` If no version ID or alias is specified, the latest version will be used. - */ - name?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via next_page_token of the previous ListModelVersionCheckpoints call. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Models$Listversions extends StandardParameters { - /** - * An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `labels.myKey="myValue"` - */ - filter?: string; - /** - * Required. The name of the model to list versions for. - */ - name?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `update_time asc, create_time desc`. - */ - orderBy?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via next_page_token of the previous ListModelVersions call. - */ - pageToken?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Models$Mergeversionaliases extends StandardParameters { - /** - * Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: `projects/{project\}/locations/{location\}/models/{model\}@1234` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1MergeVersionAliasesRequest; - } - export interface Params$Resource$Projects$Locations$Models$Patch extends StandardParameters { - /** - * Identifier. The resource name of the Model. - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Model; - } - export interface Params$Resource$Projects$Locations$Models$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Models$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Models$Updateexplanationdataset extends StandardParameters { - /** - * Required. The resource name of the Model to update. Format: `projects/{project\}/locations/{location\}/models/{model\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpdateExplanationDatasetRequest; - } - export interface Params$Resource$Projects$Locations$Models$Upload extends StandardParameters { - /** - * Required. The resource name of the Location into which to upload the Model. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UploadModelRequest; - } - - export class Resource$Projects$Locations$Models$Evaluations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Models$Evaluations$Operations; - slices: Resource$Projects$Locations$Models$Evaluations$Slices; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Models$Evaluations$Operations( - this.context + return createAPIRequest( + parameters ); - this.slices = new Resource$Projects$Locations$Models$Evaluations$Slices( - this.context - ); + } } /** - * Gets a ModelEvaluation. + * Updates a NotebookRuntimeTemplate. * @example * ```js * // Before running the sample: @@ -116026,25 +133656,64 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.get({ - * // Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.patch({ + * // The resource name of the NotebookRuntimeTemplate. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_field\}"\}` Updatable fields: * `encryption_spec.kms_key_name` * `display_name` * `software_config.post_startup_script_config.post_startup_script` * `software_config.post_startup_script_config.post_startup_script_url` * `software_config.post_startup_script_config.post_startup_script_behavior` * `software_config.env` * `software_config.colab_image.release_name` * `software_config.custom_container_config.image_uri` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, + * // "name": "my_name", + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "annotationSchemaUri": "my_annotationSchemaUri", * // "createTime": "my_createTime", - * // "dataItemSchemaUri": "my_dataItemSchemaUri", + * // "dataPersistentDiskSpec": {}, + * // "description": "my_description", * // "displayName": "my_displayName", - * // "explanationSpecs": [], - * // "metadata": {}, - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "eucConfig": {}, + * // "idleShutdownConfig": {}, + * // "isDefault": false, + * // "labels": {}, + * // "machineSpec": {}, * // "name": "my_name", - * // "sliceDimensions": [] + * // "networkSpec": {}, + * // "networkTags": [], + * // "notebookRuntimeType": "my_notebookRuntimeType", + * // "reservationAffinity": {}, + * // "serviceAccount": "my_serviceAccount", + * // "shieldedVmConfig": {}, + * // "softwareConfig": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -116060,62 +133729,62 @@ export namespace aiplatform_v1 { * @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$Models$Evaluations$Get, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Get, + patch( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Models$Evaluations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; options = {}; } @@ -116129,7 +133798,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -116140,19 +133809,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Imports an externally generated ModelEvaluation. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -116181,33 +133850,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.import({ - * // Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * parent: 'projects/my-project/locations/my-location/models/my-model', + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.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/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "modelEvaluation": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "policy": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "annotationSchemaUri": "my_annotationSchemaUri", - * // "createTime": "my_createTime", - * // "dataItemSchemaUri": "my_dataItemSchemaUri", - * // "displayName": "my_displayName", - * // "explanationSpecs": [], - * // "metadata": {}, - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, - * // "name": "my_name", - * // "sliceDimensions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -116223,62 +133886,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Import, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Models$Evaluations$Import, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - import( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Import; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Import; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; options = {}; } @@ -116291,7 +133948,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluations:import').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -116301,24 +133958,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluations in a Model. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -116347,24 +134002,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.evaluations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` - * parent: 'projects/my-project/locations/my-location/models/my-model', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions( + * { + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "modelEvaluations": [], - * // "nextPageToken": "my_nextPageToken" + * // "permissions": [] * // } * } * @@ -116380,62 +134032,62 @@ export namespace aiplatform_v1 { * @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$Models$Evaluations$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$List, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions + | 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$Models$Evaluations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$List; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; options = {}; } @@ -116448,74 +134100,134 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/evaluations').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Create extends StandardParameters { /** - * Required. The name of the ModelEvaluation resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` + * Optional. User specified ID for the notebook runtime template. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Import extends StandardParameters { + notebookRuntimeTemplateId?: string; /** - * Required. The name of the parent model resource. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportModelEvaluationRequest; + requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete extends StandardParameters { /** - * The standard list filter. + * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get extends StandardParameters { + /** + * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Locations$Notebookruntimetemplates$List extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` */ filter?: string; /** - * The standard list page size. + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + */ + orderBy?: string; + /** + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListModelEvaluationsResponse.next_page_token of the previous ModelService.ListModelEvaluations call. + * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. */ pageToken?: string; /** - * Required. The resource name of the Model to list the ModelEvaluations from. Format: `projects/{project\}/locations/{location\}/models/{model\}` + * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** - * Mask specifying which fields to read. + * Optional. Mask specifying which fields to read. */ readMask?: string; } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch extends StandardParameters { + /** + * The resource name of the NotebookRuntimeTemplate. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_field\}"\}` Updatable fields: * `encryption_spec.kms_key_name` * `display_name` * `software_config.post_startup_script_config.post_startup_script` * `software_config.post_startup_script_config.post_startup_script_url` * `software_config.post_startup_script_config.post_startup_script_behavior` * `software_config.env` * `software_config.colab_image.release_name` * `software_config.custom_container_config.image_uri` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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; - export class Resource$Projects$Locations$Models$Evaluations$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -116552,10 +134264,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', - * }); + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -116575,31 +134289,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -116615,13 +134329,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; options = {}; } @@ -116686,10 +134400,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', - * }); + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -116709,31 +134425,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -116749,13 +134465,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; options = {}; } @@ -116820,10 +134536,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', - * }); + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -116849,27 +134567,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -116877,7 +134594,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -116893,13 +134610,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; options = {}; } @@ -116964,18 +134681,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -116999,29 +134718,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$List, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, callback: BodyResponseCallback ): void; list( @@ -117029,7 +134748,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$List + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -117047,13 +134766,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$List; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; options = {}; } @@ -117123,12 +134842,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.models.evaluations.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -117154,27 +134875,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait, + params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -117182,7 +134902,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait + | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -117198,13 +134918,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait; + {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; options = {}; } @@ -117239,25 +134959,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -117279,7 +134999,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -117290,14 +135010,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Models$Evaluations$Slices { + export class Resource$Projects$Locations$Onlineevaluators { context: APIRequestContext; + operations: Resource$Projects$Locations$Onlineevaluators$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Onlineevaluators$Operations( + this.context + ); } /** - * Imports a list of externally generated EvaluatedAnnotations. + * Activates an OnlineEvaluator. * @example * ```js * // Before running the sample: @@ -117326,25 +135051,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.models.evaluations.slices.batchImport({ - * // Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - * parent: - * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', + * const res = await aiplatform.projects.locations.onlineEvaluators.activate({ + * // Required. The name of the OnlineEvaluator to activate. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "evaluatedAnnotations": [] - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "importedEvaluatedAnnotationsCount": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -117360,62 +135085,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + activate( + params: Params$Resource$Projects$Locations$Onlineevaluators$Activate, options: StreamMethodOptions ): Promise>; - batchImport( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + activate( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Activate, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + ): Promise>; + activate( + params: Params$Resource$Projects$Locations$Onlineevaluators$Activate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, + activate( + params: Params$Resource$Projects$Locations$Onlineevaluators$Activate, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchImport( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport, - callback: BodyResponseCallback + activate( + params: Params$Resource$Projects$Locations$Onlineevaluators$Activate, + callback: BodyResponseCallback ): void; - batchImport( - callback: BodyResponseCallback + activate( + callback: BodyResponseCallback ): void; - batchImport( + activate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Activate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Activate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport; + {} as Params$Resource$Projects$Locations$Onlineevaluators$Activate; options = {}; } @@ -117428,7 +135148,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:batchImport').replace( + url: (rootUrl + '/v1/{+name}:activate').replace( /([^:]\/)\/+/g, '$1' ), @@ -117438,176 +135158,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Gets a ModelEvaluationSlice. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.models.evaluations.slices.get( - * { - * // Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - * name: 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation/slices/my-slice', - * }, - * ); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "metrics": {}, - * // "metricsSchemaUri": "my_metricsSchemaUri", - * // "modelExplanation": {}, - * // "name": "my_name", - * // "slice": {} - * // } - * } - * - * 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$Models$Evaluations$Slices$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.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( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists ModelEvaluationSlices in a ModelEvaluation. + * Creates an OnlineEvaluator in the given project and location. * @example * ```js * // Before running the sample: @@ -117636,26 +135202,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.models.evaluations.slices.list({ - * // The standard list filter. * `slice.dimension` - for =. - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - * parent: - * 'projects/my-project/locations/my-location/models/my-model/evaluations/my-evaluation', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.onlineEvaluators.create({ + * // Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentResource": "my_agentResource", + * // "cloudObservability": {}, + * // "config": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "metricSources": [], + * // "name": "my_name", + * // "state": "my_state", + * // "stateDetails": [], + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "modelEvaluationSlices": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -117671,62 +135247,57 @@ export namespace aiplatform_v1 { * @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$Models$Evaluations$Slices$List, + create( + params: Params$Resource$Projects$Locations$Onlineevaluators$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + create( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Onlineevaluators$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, + create( + params: Params$Resource$Projects$Locations$Onlineevaluators$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Evaluations$Slices$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Onlineevaluators$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Evaluations$Slices$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Evaluations$Slices$List; + {} as Params$Resource$Projects$Locations$Onlineevaluators$Create; options = {}; } @@ -117739,11 +135310,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/slices').replace( + url: (rootUrl + '/v1/{+parent}/onlineEvaluators').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -117754,66 +135325,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Batchimport extends StandardParameters { /** - * Required. The name of the parent ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchImportEvaluatedAnnotationsRequest; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$Get extends StandardParameters { - /** - * Required. The name of the ModelEvaluationSlice resource. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}/slices/{slice\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Models$Evaluations$Slices$List extends StandardParameters { - /** - * The standard list filter. * `slice.dimension` - for =. - */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListModelEvaluationSlicesResponse.next_page_token of the previous ModelService.ListModelEvaluationSlices call. - */ - pageToken?: string; - /** - * Required. The resource name of the ModelEvaluation to list the ModelEvaluationSlices from. Format: `projects/{project\}/locations/{location\}/models/{model\}/evaluations/{evaluation\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - - export class Resource$Projects$Locations$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes an OnlineEvaluator. * @example * ```js * // Before running the sample: @@ -117842,14 +135364,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.onlineEvaluators.delete({ + * // Required. The name of the OnlineEvaluator to delete. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -117864,54 +135392,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Models$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Delete, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Models$Operations$Cancel, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Delete, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + callback: BodyResponseCallback + ): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Onlineevaluators$Delete; options = {}; } @@ -117924,8 +135455,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -117936,17 +135467,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets details of an OnlineEvaluator. * @example * ```js * // Before running the sample: @@ -117975,14 +135506,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.onlineEvaluators.get({ + * // Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "agentResource": "my_agentResource", + * // "cloudObservability": {}, + * // "config": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "metricSources": [], + * // "name": "my_name", + * // "state": "my_state", + * // "stateDetails": [], + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -117997,54 +135539,61 @@ export namespace aiplatform_v1 { * @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$Models$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Models$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Models$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Models$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Onlineevaluators$Get; options = {}; } @@ -118058,7 +135607,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -118069,17 +135618,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Lists the OnlineEvaluators for the given project and location. * @example * ```js * // Before running the sample: @@ -118108,19 +135659,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', + * const res = await aiplatform.projects.locations.onlineEvaluators.list({ + * // Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time\>"2026-01-01T00:00:00-04:00"` where the timestamp is in RFC 3339 format) Based on aip.dev/160. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158. + * pageSize: 'placeholder-value', + * // Optional. A token identifying a page of results the server should return. Based on aip.dev/158. + * pageToken: 'placeholder-value', + * // Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project\}/locations/{location\}. + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "onlineEvaluators": [] * // } * } * @@ -118136,57 +135692,61 @@ export namespace aiplatform_v1 { * @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$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Models$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Onlineevaluators$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Models$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Models$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Onlineevaluators$List; options = {}; } @@ -118199,29 +135759,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/onlineEvaluators').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the fields of an OnlineEvaluator. * @example * ```js * // Before running the sample: @@ -118250,25 +135815,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/models/my-model', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.onlineEvaluators.patch({ + * // Identifier. The resource name of the OnlineEvaluator. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', + * // Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agentResource": "my_agentResource", + * // "cloudObservability": {}, + * // "config": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "metricSources": [], + * // "name": "my_name", + * // "state": "my_state", + * // "stateDetails": [], + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -118284,62 +135862,57 @@ export namespace aiplatform_v1 { * @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$Models$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Onlineevaluators$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Models$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Onlineevaluators$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Onlineevaluators$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Models$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Onlineevaluators$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Onlineevaluators$Patch; options = {}; } @@ -118352,11 +135925,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -118367,19 +135937,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Suspends an OnlineEvaluator. When an OnlineEvaluator is suspended, it won't run any evaluations until it is activated again. * @example * ```js * // Before running the sample: @@ -118408,11 +135976,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.models.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/models/my-model/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.onlineEvaluators.suspend({ + * // Required. The name of the OnlineEvaluator to suspend. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -118438,36 +136010,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + suspend( + params: Params$Resource$Projects$Locations$Onlineevaluators$Suspend, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Models$Operations$Wait, + suspend( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Suspend, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + suspend( + params: Params$Resource$Projects$Locations$Onlineevaluators$Suspend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + suspend( + params: Params$Resource$Projects$Locations$Onlineevaluators$Suspend, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Models$Operations$Wait, + suspend( + params: Params$Resource$Projects$Locations$Onlineevaluators$Suspend, callback: BodyResponseCallback ): void; - wait( + suspend( callback: BodyResponseCallback ): void; - wait( + suspend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Models$Operations$Wait + | Params$Resource$Projects$Locations$Onlineevaluators$Suspend | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -118483,13 +136054,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Models$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Suspend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Models$Operations$Wait; + {} as Params$Resource$Projects$Locations$Onlineevaluators$Suspend; options = {}; } @@ -118502,7 +136073,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:suspend').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -118524,68 +136098,97 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Models$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Activate extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the OnlineEvaluator to activate. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ActivateOnlineEvaluatorRequest; } - export interface Params$Resource$Projects$Locations$Models$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The parent resource where the OnlineEvaluator will be created. Format: projects/{project\}/locations/{location\}. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1OnlineEvaluator; + } + export interface Params$Resource$Projects$Locations$Onlineevaluators$Delete extends StandardParameters { + /** + * Required. The name of the OnlineEvaluator to delete. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the OnlineEvaluator to retrieve. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$List extends StandardParameters { /** - * The standard list filter. + * Optional. Standard list filter. Supported fields: * `create_time` * `update_time` * `agent_resource` Example: `create_time\>"2026-01-01T00:00:00-04:00"` where the timestamp is in RFC 3339 format) Based on aip.dev/160. */ filter?: string; /** - * The name of the operation's parent resource. + * Optional. A comma-separated list of fields to order by. The default sorting order is ascending. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. Based on aip.dev/132. */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * Optional. The maximum number of OnlineEvaluators to return. The service may return fewer than this value. If unspecified, at most 100 OnlineEvaluators will be returned. The maximum value is 100; values above 100 will be coerced to 100. Based on aip.dev/158. */ pageSize?: number; /** - * The standard list page token. + * Optional. A token identifying a page of results the server should return. Based on aip.dev/158. */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The parent resource of the OnlineEvaluators to list. Format: projects/{project\}/locations/{location\}. */ - returnPartialSuccess?: boolean; + parent?: string; } - export interface Params$Resource$Projects$Locations$Models$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Identifier. The resource name of the OnlineEvaluator. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1OnlineEvaluator; } + export interface Params$Resource$Projects$Locations$Onlineevaluators$Suspend extends StandardParameters { + /** + * Required. The name of the OnlineEvaluator to suspend. Format: projects/{project\}/locations/{location\}/onlineEvaluators/{id\}. + */ + name?: string; - export class Resource$Projects$Locations$Nasjobs { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SuspendOnlineEvaluatorRequest; + } + + export class Resource$Projects$Locations$Onlineevaluators$Operations { context: APIRequestContext; - nasTrialDetails: Resource$Projects$Locations$Nasjobs$Nastrialdetails; constructor(context: APIRequestContext) { this.context = context; - this.nasTrialDetails = - new Resource$Projects$Locations$Nasjobs$Nastrialdetails(this.context); } /** - * Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and NasJob.state is set to `CANCELLED`. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -118614,16 +136217,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.cancel({ - * // Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.onlineEvaluators.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -118643,31 +136241,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params?: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Nasjobs$Cancel, + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Cancel + | Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -118683,12 +136281,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Cancel; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel; options = {}; } @@ -118723,7 +136322,7 @@ export namespace aiplatform_v1 { } /** - * Creates a NasJob + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -118752,52 +136351,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.create({ - * // Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.onlineEvaluators.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -118812,57 +136374,54 @@ export namespace aiplatform_v1 { * @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$Nasjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Nasjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Nasjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Create; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Create; + params = + {} as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete; options = {}; } @@ -118875,34 +136434,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a NasJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -118931,10 +136485,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.delete({ - * // Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * }); + * const res = + * await aiplatform.projects.locations.onlineEvaluators.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -118959,36 +136514,35 @@ export namespace aiplatform_v1 { * @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$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Nasjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Delete + | Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -119004,12 +136558,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Delete; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get; options = {}; } @@ -119023,7 +136578,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -119044,7 +136599,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NasJob + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -119065,10 +136620,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -119076,29 +136628,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.get({ - * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * }); + * const res = + * await aiplatform.projects.locations.onlineEvaluators.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "enableRestrictedImageTraining": false, - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "labels": {}, - * // "name": "my_name", - * // "nasJobOutput": {}, - * // "nasJobSpec": {}, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -119114,57 +136663,62 @@ export namespace aiplatform_v1 { * @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$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Operations$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Get; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$Get; + params = + {} as Params$Resource$Projects$Locations$Onlineevaluators$Operations$List; options = {}; } @@ -119177,7 +136731,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -119189,19 +136746,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NasJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -119230,24 +136787,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.onlineEvaluators.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/onlineEvaluators/my-onlineEvaluator/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nasJobs": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -119263,61 +136818,57 @@ export namespace aiplatform_v1 { * @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$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + wait( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$List; + {}) as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + params = + {} as Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait; options = {}; } @@ -119330,98 +136881,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Nasjobs$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Operations$Cancel extends StandardParameters { /** - * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NasJob; } - export interface Params$Resource$Projects$Locations$Nasjobs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Operations$Delete extends StandardParameters { /** - * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Operations$Get extends StandardParameters { /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Onlineevaluators$Operations$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * 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. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Onlineevaluators$Operations$Wait extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a NasTrialDetail. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -119450,19 +136990,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.nasJobs.nasTrialDetails.get({ - * // Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` - * name: 'projects/my-project/locations/my-location/nasJobs/my-nasJob/nasTrialDetails/my-nasTrialDetail', + * const res = await aiplatform.projects.locations.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "name": "my_name", - * // "parameters": "my_parameters", - * // "searchTrial": {}, - * // "trainTrial": {} - * // } + * // {} * } * * main().catch(e => { @@ -119477,62 +137012,53 @@ export namespace aiplatform_v1 { * @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$Nasjobs$Nastrialdetails$Get, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -119545,8 +137071,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -119557,205 +137083,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * List top NasTrialDetails of a NasJob. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.nasJobs.nasTrialDetails.list({ - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. - * pageToken: 'placeholder-value', - * // Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - * parent: 'projects/my-project/locations/my-location/nasJobs/my-nasJob', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nasTrialDetails": [], - * // "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$Nasjobs$Nastrialdetails$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get extends StandardParameters { - /** - * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List extends StandardParameters { - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. - */ - pageToken?: string; - /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Notebookexecutionjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookexecutionjobs$Operations( - this.context - ); - } /** - * Creates a NotebookExecutionJob. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -119784,49 +137122,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.create({ - * // Optional. User specified ID for the NotebookExecutionJob. - * notebookExecutionJobId: 'placeholder-value', - * // Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "customEnvironmentSpec": {}, - * // "dataformRepositorySource": {}, - * // "directNotebookSource": {}, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "executionTimeout": "my_executionTimeout", - * // "executionUser": "my_executionUser", - * // "gcsNotebookSource": {}, - * // "gcsOutputUri": "my_gcsOutputUri", - * // "jobState": "my_jobState", - * // "kernelName": "my_kernelName", - * // "labels": {}, - * // "name": "my_name", - * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", - * // "scheduleResourceName": "my_scheduleResourceName", - * // "serviceAccount": "my_serviceAccount", - * // "status": {}, - * // "updateTime": "my_updateTime", - * // "workbenchRuntime": {} - * // } - * }, + * const res = await aiplatform.projects.locations.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -119841,58 +137144,53 @@ export namespace aiplatform_v1 { * @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$Notebookexecutionjobs$Create, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -119905,32 +137203,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a NotebookExecutionJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -119959,9 +137254,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.delete({ - * // Required. The name of the NotebookExecutionJob resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', + * const res = await aiplatform.projects.locations.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/operations/my-operation', * }); * console.log(res.data); * @@ -119987,36 +137282,35 @@ export namespace aiplatform_v1 { * @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$Notebookexecutionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -120032,13 +137326,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -120052,7 +137345,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -120073,7 +137366,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NotebookExecutionJob. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -120101,37 +137394,26 @@ export namespace aiplatform_v1 { * const authClient = await auth.getClient(); * google.options({auth: authClient}); * - * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.get({ - * // Required. The name of the NotebookExecutionJob resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', - * // Optional. The NotebookExecutionJob view. Defaults to BASIC. - * view: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "createTime": "my_createTime", - * // "customEnvironmentSpec": {}, - * // "dataformRepositorySource": {}, - * // "directNotebookSource": {}, - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "executionTimeout": "my_executionTimeout", - * // "executionUser": "my_executionUser", - * // "gcsNotebookSource": {}, - * // "gcsOutputUri": "my_gcsOutputUri", - * // "jobState": "my_jobState", - * // "kernelName": "my_kernelName", - * // "labels": {}, - * // "name": "my_name", - * // "notebookRuntimeTemplateResourceName": "my_notebookRuntimeTemplateResourceName", - * // "scheduleResourceName": "my_scheduleResourceName", - * // "serviceAccount": "my_serviceAccount", - * // "status": {}, - * // "updateTime": "my_updateTime", - * // "workbenchRuntime": {} + * // Do the magic + * const res = await aiplatform.projects.locations.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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": [] * // } * } * @@ -120147,62 +137429,61 @@ export namespace aiplatform_v1 { * @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$Notebookexecutionjobs$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$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$Notebookexecutionjobs$Get; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -120215,7 +137496,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -120227,19 +137511,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NotebookExecutionJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -120268,26 +137552,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookExecutionJobs.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. The NotebookExecutionJob view. Defaults to BASIC. - * view: 'placeholder-value', + * const res = await aiplatform.projects.locations.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notebookExecutionJobs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -120303,62 +137582,56 @@ export namespace aiplatform_v1 { * @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$Notebookexecutionjobs$List, + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + wait( + params?: Params$Resource$Projects$Locations$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + {}) as Params$Resource$Projects$Locations$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; + params = {} as Params$Resource$Projects$Locations$Operations$Wait; options = {}; } @@ -120371,99 +137644,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create extends StandardParameters { - /** - * Optional. User specified ID for the NotebookExecutionJob. - */ - notebookExecutionJobId?: string; - /** - * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; + name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { /** - * Required. The name of the NotebookExecutionJob resource to be deleted. + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { /** - * Required. The name of the NotebookExecutionJob resource. + * The name of the operation resource. */ name?: string; - /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` + * The standard list filter. */ filter?: string; /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Optional. The standard list page size. + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobsResponse.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Operations$Wait extends StandardParameters { /** - * Optional. The NotebookExecutionJob view. Defaults to BASIC. + * The name of the operation resource to wait on. */ - view?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { + export class Resource$Projects$Locations$Persistentresources { context: APIRequestContext; + operations: Resource$Projects$Locations$Persistentresources$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Persistentresources$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a PersistentResource. * @example * ```js * // Before running the sample: @@ -120492,17 +137758,46 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.persistentResources.create({ + * // Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + * persistentResourceId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -120517,54 +137812,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Persistentresources$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Persistentresources$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Persistentresources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Persistentresources$Create; options = {}; } @@ -120577,29 +137875,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a PersistentResource. * @example * ```js * // Before running the sample: @@ -120628,17 +137929,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.persistentResources.delete({ + * // Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -120654,53 +137958,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Persistentresources$Delete; options = {}; } @@ -120725,17 +138032,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a PersistentResource. * @example * ```js * // Before running the sample: @@ -120764,20 +138071,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.persistentResources.get({ + * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, * // "error": {}, - * // "metadata": {}, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -120794,57 +138112,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Persistentresources$Get; options = {}; } @@ -120869,17 +138191,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists PersistentResources in a Location. * @example * ```js * // Before running the sample: @@ -120908,26 +138232,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.persistentResources.list({ + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "persistentResources": [] * // } * } * @@ -120944,61 +138262,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params?: Params$Resource$Projects$Locations$Persistentresources$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, + params: Params$Resource$Projects$Locations$Persistentresources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$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$Notebookexecutionjobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List; + {} as Params$Resource$Projects$Locations$Persistentresources$List; options = {}; } @@ -121011,7 +138329,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/persistentResources').replace( /([^:]\/)\/+/g, '$1' ), @@ -121021,24 +138339,24 @@ export namespace aiplatform_v1 { 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 ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates a PersistentResource. * @example * ```js * // Before running the sample: @@ -121067,13 +138385,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookExecutionJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookExecutionJobs/my-notebookExecutionJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.persistentResources.patch({ + * // Immutable. Resource name of a PersistentResource. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * // Required. Specify the fields to be overwritten in the PersistentResource by the update method. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "error": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "resourcePools": [], + * // "resourceRuntime": {}, + * // "resourceRuntimeSpec": {}, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -121098,36 +138439,183 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Persistentresources$Patch, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Persistentresources$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Persistentresources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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); + } + } + + /** + * Reboots a PersistentResource. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.persistentResources.reboot({ + * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); + * 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. + */ + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions + ): Promise>; + reboot( + params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options?: MethodOptions + ): Promise>; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + options: + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait, + reboot( + params: Params$Resource$Projects$Locations$Persistentresources$Reboot, callback: BodyResponseCallback ): void; - wait( + reboot( callback: BodyResponseCallback ): void; - wait( + reboot( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait + | Params$Resource$Projects$Locations$Persistentresources$Reboot | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121143,13 +138631,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; options = {}; } @@ -121162,7 +138650,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:reboot').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -121184,70 +138672,82 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Persistentresources$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + /** + * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. + */ + persistentResourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Persistentresources$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Persistentresources$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Persistentresources$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list page size. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. */ - name?: string; + pageToken?: string; /** - * The standard list page size. + * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` */ - pageSize?: number; + parent?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Patch extends StandardParameters { /** - * The standard list page token. + * Immutable. Resource name of a PersistentResource. */ - pageToken?: string; + name?: 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. Specify the fields to be overwritten in the PersistentResource by the update method. */ - returnPartialSuccess?: boolean; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; } - export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Persistentresources$Reboot extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest; } - export class Resource$Projects$Locations$Notebookruntimes { + export class Resource$Projects$Locations$Persistentresources$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimes$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookruntimes$Operations( - this.context - ); } /** - * Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -121276,30 +138776,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.assign({ - * // Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "notebookRuntime": {}, - * // "notebookRuntimeId": "my_notebookRuntimeId", - * // "notebookRuntimeTemplate": "my_notebookRuntimeTemplate" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.persistentResources.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -121314,58 +138799,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + cancel( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions ): Promise>; - assign( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + cancel( + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options?: MethodOptions - ): Promise>; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - assign( - params: Params$Resource$Projects$Locations$Notebookruntimes$Assign, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - assign( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + callback: BodyResponseCallback ): void; - assign( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Assign - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Assign; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; options = {}; } @@ -121378,32 +138859,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimes:assign').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a NotebookRuntime. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -121432,20 +138910,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.delete({ - * // Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * }); + * const res = + * await aiplatform.projects.locations.persistentResources.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -121461,57 +138934,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Delete; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; options = {}; } @@ -121536,17 +139005,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a NotebookRuntime. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -121575,42 +139044,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.get({ - * // Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * }); + * const res = + * await aiplatform.projects.locations.persistentResources.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "eucConfig": {}, - * // "expirationTime": "my_expirationTime", - * // "healthState": "my_healthState", - * // "idleShutdownConfig": {}, - * // "isUpgradable": false, - * // "labels": {}, - * // "machineSpec": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeTemplateRef": {}, - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "proxyUri": "my_proxyUri", - * // "reservationAffinity": {}, - * // "runtimeState": "my_runtimeState", - * // "runtimeUser": "my_runtimeUser", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime", - * // "version": "my_version" + * // "response": {} * // } * } * @@ -121627,60 +139074,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Get; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Get; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; options = {}; } @@ -121705,19 +139148,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists NotebookRuntimes in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -121746,26 +139187,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.list({ - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.persistentResources.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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", - * // "notebookRuntimes": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -121782,60 +139223,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$List, + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Persistentresources$Operations$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$Notebookruntimes$List; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$List; + params = + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; options = {}; } @@ -121848,7 +139290,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimes').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -121858,24 +139300,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Starts a NotebookRuntime. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -121904,16 +139346,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.start({ - * // Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.persistentResources.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -121938,36 +139377,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + wait( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions ): Promise>; - start( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Start, + wait( + params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options?: MethodOptions ): Promise>; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + wait( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + wait( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - start( - params: Params$Resource$Projects$Locations$Notebookruntimes$Start, + wait( + params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, callback: BodyResponseCallback ): void; - start( + wait( callback: BodyResponseCallback ): void; - start( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Start + | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -121983,13 +139421,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Start; + {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Start; + {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; options = {}; } @@ -122002,7 +139440,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:start').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -122022,9 +139460,71 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel extends StandardParameters { /** - * Stops a NotebookRuntime. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Persistentresources$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Pipelinejobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Pipelinejobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( + this.context + ); + } + + /** + * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. * @example * ```js * // Before running the sample: @@ -122053,14 +139553,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.stop({ - * // Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * const res = await aiplatform.projects.locations.pipelineJobs.batchCancel({ + * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "names": [] + * // } * }, * }); * console.log(res.data); @@ -122087,36 +139589,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + batchCancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options?: MethodOptions ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Notebookruntimes$Stop, + batchCancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, callback: BodyResponseCallback ): void; - stop( + batchCancel( callback: BodyResponseCallback ): void; - stop( + batchCancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Stop + | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122132,12 +139633,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Stop; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notebookruntimes$Stop; + params = + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; options = {}; } @@ -122150,15 +139652,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchCancel').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -122172,7 +139677,7 @@ export namespace aiplatform_v1 { } /** - * Upgrades a NotebookRuntime. + * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. * @example * ```js * // Before running the sample: @@ -122201,14 +139706,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimes.upgrade({ - * // Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', + * const res = await aiplatform.projects.locations.pipelineJobs.batchDelete({ + * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "names": [] + * // } * }, * }); * console.log(res.data); @@ -122235,36 +139742,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions ): Promise>; - upgrade( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + batchDelete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options?: MethodOptions ): Promise>; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upgrade( - params: Params$Resource$Projects$Locations$Notebookruntimes$Upgrade, + batchDelete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, callback: BodyResponseCallback ): void; - upgrade( + batchDelete( callback: BodyResponseCallback ): void; - upgrade( + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Upgrade + | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122280,13 +139786,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Upgrade; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; options = {}; } @@ -122299,7 +139805,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:upgrade').replace( + url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchDelete').replace( /([^:]\/)\/+/g, '$1' ), @@ -122309,8 +139815,8 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -122322,99 +139828,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notebookruntimes$Assign extends StandardParameters { - /** - * Required. The resource name of the Location to get the NotebookRuntime assignment. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AssignNotebookRuntimeRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Delete extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be deleted. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Get extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED, ERROR, INVALID]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimes call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the NotebookRuntimes. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Start extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be started. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StartNotebookRuntimeRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Stop extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be stopped. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StopNotebookRuntimeRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Upgrade extends StandardParameters { - /** - * Required. The name of the NotebookRuntime resource to be upgrade. Instead of checking whether the name is in valid NotebookRuntime resource name format, directly throw NotFound exception if there is no such NotebookRuntime in spanner. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1UpgradeNotebookRuntimeRequest; - } - - export class Resource$Projects$Locations$Notebookruntimes$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -122443,11 +139859,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.cancel({ + * // Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -122467,31 +139888,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel, + params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel + | Params$Resource$Projects$Locations$Pipelinejobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -122507,13 +139928,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; options = {}; } @@ -122548,7 +139968,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a PipelineJob. A PipelineJob will run immediately when created. * @example * ```js * // Before running the sample: @@ -122577,15 +139997,217 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.create({ + * // Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. + * pipelineJobId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobDetail": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "jobDetail": {}, + * // "labels": {}, + * // "name": "my_name", + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "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$Pipelinejobs$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelinejobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/pipelineJobs').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 a PipelineJob. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.pipelineJobs.delete({ + * // Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -122601,53 +140223,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; options = {}; } @@ -122672,17 +140296,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a PipelineJob. * @example * ```js * // Before running the sample: @@ -122711,20 +140335,35 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.get({ + * // Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", * // "error": {}, - * // "metadata": {}, + * // "jobDetail": {}, + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "network": "my_network", + * // "pipelineSpec": {}, + * // "preflightValidations": false, + * // "pscInterfaceConfig": {}, + * // "reservedIpRanges": [], + * // "runtimeConfig": {}, + * // "scheduleName": "my_scheduleName", + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "templateMetadata": {}, + * // "templateUri": "my_templateUri", + * // "updateTime": "my_updateTime" * // } * } * @@ -122741,57 +140380,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; options = {}; } @@ -122816,17 +140458,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists PipelineJobs in a Location. * @example * ```js * // Before running the sample: @@ -122855,26 +140499,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.list({ + * // Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` + * orderBy: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "pipelineJobs": [] * // } * } * @@ -122891,61 +140535,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params?: Params$Resource$Projects$Locations$Pipelinejobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, + params: Params$Resource$Projects$Locations$Pipelinejobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Pipelinejobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$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$Notebookruntimes$Operations$List; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$List; + params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; options = {}; } @@ -122958,7 +140601,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -122968,24 +140611,118 @@ export namespace aiplatform_v1 { 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$Pipelinejobs$Batchcancel extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete extends StandardParameters { + /** + * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel extends StandardParameters { + /** + * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelPipelineJobRequest; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. + */ + pipelineJobId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PipelineJob; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete extends StandardParameters { + /** + * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Get extends StandardParameters { + /** + * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$List extends StandardParameters { + /** + * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` + */ + orderBy?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Pipelinejobs$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -123015,22 +140752,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimes.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookRuntimes/my-notebookRuntime/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.projects.locations.pipelineJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -123045,58 +140774,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + cancel( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + callback: BodyResponseCallback ): void; - wait( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; options = {}; } @@ -123109,7 +140834,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -123121,80 +140846,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Notebookruntimes$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Notebookruntimetemplates { - context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookruntimetemplates$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookruntimetemplates$Operations( - this.context - ); - } /** - * Creates a NotebookRuntimeTemplate. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -123224,49 +140886,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.create({ - * // Optional. User specified ID for the notebook runtime template. - * notebookRuntimeTemplateId: 'placeholder-value', - * // Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * await aiplatform.projects.locations.pipelineJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -123281,58 +140908,54 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Create, + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + delete( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Create; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; options = {}; } @@ -123345,32 +140968,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a NotebookRuntimeTemplate. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -123399,11 +141019,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.delete({ - * // Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -123428,36 +141047,35 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + get( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -123473,13 +141091,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; options = {}; } @@ -123493,7 +141111,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -123514,7 +141132,7 @@ export namespace aiplatform_v1 { } /** - * Gets a NotebookRuntimeTemplate. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -123543,34 +141161,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.get({ - * // Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * const res = await aiplatform.projects.locations.pipelineJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -123586,62 +141195,62 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$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$Notebookruntimetemplates$Get; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Get; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; options = {}; } @@ -123654,7 +141263,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -123666,19 +141278,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -123707,21 +141319,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.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/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * }); + * const res = await aiplatform.projects.locations.pipelineJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -123737,56 +141349,57 @@ export namespace aiplatform_v1 { * @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$Locations$Notebookruntimetemplates$Getiampolicy, + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + wait( + params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - getIamPolicy( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Getiampolicy; + {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; options = {}; } @@ -123799,32 +141412,104 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel extends StandardParameters { /** - * Lists NotebookRuntimeTemplates in a Location. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Publishers { + context: APIRequestContext; + models: Resource$Projects$Locations$Publishers$Models; + v1: Resource$Projects$Locations$Publishers$V1; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Projects$Locations$Publishers$Models( + this.context + ); + this.v1 = new Resource$Projects$Locations$Publishers$V1(this.context); + } + } + + export class Resource$Projects$Locations$Publishers$Models { + context: APIRequestContext; + invoke: Resource$Projects$Locations$Publishers$Models$Invoke; + constructor(context: APIRequestContext) { + this.context = context; + this.invoke = new Resource$Projects$Locations$Publishers$Models$Invoke( + this.context + ); + } + + /** + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -123853,28 +141538,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.notebookRuntimeTemplates.list( - * { - * // Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Optional. Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * const res = + * await aiplatform.projects.locations.publishers.models.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "notebookRuntimeTemplates": [] + * // "tokensInfo": [] * // } * } * @@ -123890,62 +141574,62 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$List, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + computeTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$List, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + computeTokens( + callback: BodyResponseCallback ): void; - list( + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Computetokens + | 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$Notebookruntimetemplates$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; options = {}; } @@ -123958,34 +141642,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/notebookRuntimeTemplates').replace( + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a NotebookRuntimeTemplate. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -124014,64 +141698,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.patch({ - * // The resource name of the NotebookRuntimeTemplate. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * // Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_field\}"\}` Updatable fields: * `encryption_spec.kms_key_name` * `display_name` * `software_config.post_startup_script_config.post_startup_script` * `software_config.post_startup_script_config.post_startup_script_url` * `software_config.post_startup_script_config.post_startup_script_behavior` * `software_config.env` * `software_config.colab_image.release_name` * `software_config.custom_container_config.image_uri` - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.publishers.models.countTokens( + * { + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "dataPersistentDiskSpec": {}, - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "eucConfig": {}, - * // "idleShutdownConfig": {}, - * // "isDefault": false, - * // "labels": {}, - * // "machineSpec": {}, - * // "name": "my_name", - * // "networkSpec": {}, - * // "networkTags": [], - * // "notebookRuntimeType": "my_notebookRuntimeType", - * // "reservationAffinity": {}, - * // "serviceAccount": "my_serviceAccount", - * // "shieldedVmConfig": {}, - * // "softwareConfig": {}, - * // "updateTime": "my_updateTime" + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 0 * // } * } * @@ -124087,62 +141740,62 @@ export namespace aiplatform_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$Notebookruntimetemplates$Patch, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + countTokens( + params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch, - callback: BodyResponseCallback + countTokens( + params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + countTokens( + callback: BodyResponseCallback ): void; - patch( + countTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Counttokens + | 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$Notebookruntimetemplates$Patch; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch; + {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; options = {}; } @@ -124155,31 +141808,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Embed content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -124200,7 +141856,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -124209,16 +141868,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.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/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * await aiplatform.projects.locations.publishers.models.embedContent({ + * // Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "policy": {} + * // "autoTruncate": false, + * // "content": {}, + * // "embedContentConfig": {}, + * // "outputDimensionality": 0, + * // "taskType": "my_taskType", + * // "title": "my_title" * // } * }, * }); @@ -124226,9 +141890,9 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "embedding": {}, + * // "truncated": false, + * // "usageMetadata": {} * // } * } * @@ -124244,56 +141908,62 @@ export namespace aiplatform_v1 { * @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$Locations$Notebookruntimetemplates$Setiampolicy, + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + embedContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy, - callback: BodyResponseCallback + embedContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + embedContent( + callback: BodyResponseCallback ): void; - setIamPolicy( + embedContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Embedcontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Embedcontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Setiampolicy; + {} as Params$Resource$Projects$Locations$Publishers$Models$Embedcontent; options = {}; } @@ -124306,7 +141976,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+model}:embedContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -124316,22 +141986,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Fetch an asynchronous online prediction operation. * @example * ```js * // Before running the sample: @@ -124352,7 +142024,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -124361,20 +142036,30 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.testIamPermissions( + * await aiplatform.projects.locations.publishers.models.fetchPredictOperation( * { - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "permissions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -124390,62 +142075,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + fetchPredictOperation( + params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions, - callback: BodyResponseCallback + fetchPredictOperation( + params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + fetchPredictOperation( + callback: BodyResponseCallback ): void; - testIamPermissions( + fetchPredictOperation( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions; + {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; options = {}; } @@ -124453,146 +142133,37 @@ export namespace aiplatform_v1 { callback = optionsOrCallback; options = {}; } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').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$Locations$Notebookruntimetemplates$Create extends StandardParameters { - /** - * Optional. User specified ID for the notebook runtime template. - */ - notebookRuntimeTemplateId?: string; - /** - * Required. The resource name of the Location to create the NotebookRuntimeTemplate. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Delete extends StandardParameters { - /** - * Required. The name of the NotebookRuntimeTemplate resource to be deleted. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Get extends StandardParameters { - /** - * Required. The name of the NotebookRuntimeTemplate resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimeTemplates/{notebook_runtime_template\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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$Locations$Notebookruntimetemplates$List extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. * `machineType` supports = and !=. * `acceleratorType` supports = and !=. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` * `machineType=e2-standard-4` * `acceleratorType=NVIDIA_TESLA_T4` - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListNotebookRuntimeTemplatesResponse.next_page_token of the previous NotebookService.ListNotebookRuntimeTemplates call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the NotebookRuntimeTemplates. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Optional. Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Patch extends StandardParameters { - /** - * The resource name of the NotebookRuntimeTemplate. - */ - name?: string; - /** - * Required. The update mask applies to the resource. For the `FieldMask` definition, see google.protobuf.FieldMask. Input format: `{paths: "${updated_field\}"\}` Updatable fields: * `encryption_spec.kms_key_name` * `display_name` * `software_config.post_startup_script_config.post_startup_script` * `software_config.post_startup_script_config.post_startup_script_url` * `software_config.post_startup_script_config.post_startup_script_behavior` * `software_config.env` * `software_config.colab_image.release_name` * `software_config.custom_container_config.image_uri` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplate; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Notebookruntimetemplates$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Generate content with multimodal inputs. * @example * ```js * // Before running the sample: @@ -124613,7 +142184,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -124622,16 +142196,38 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * await aiplatform.projects.locations.publishers.models.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } * } * * main().catch(e => { @@ -124646,54 +142242,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + generateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + generateContent( + callback: BodyResponseCallback + ): void; + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; options = {}; } @@ -124706,29 +142310,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+model}:generateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -124749,7 +142357,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -124757,17 +142368,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.publishers.models.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] + * // } * } * * main().catch(e => { @@ -124782,54 +142408,62 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Operations$Delete, + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + predict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete, - callback: BodyResponseCallback + predict( + params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + predict( + callback: BodyResponseCallback + ): void; + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Predict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; options = {}; } @@ -124842,29 +142476,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:predict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -124885,7 +142523,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -124894,12 +142535,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', + * await aiplatform.projects.locations.publishers.models.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -124924,36 +142574,35 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + predictLongRunning( + params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get, + predictLongRunning( + params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, callback: BodyResponseCallback ): void; - get( + predictLongRunning( callback: BodyResponseCallback ): void; - get( + predictLongRunning( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get + | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -124969,13 +142618,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get; + {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; options = {}; } @@ -124988,15 +142637,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { @@ -125010,7 +142662,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. * @example * ```js * // Before running the sample: @@ -125031,7 +142683,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125039,28 +142694,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.publishers.models.rawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -125076,62 +142729,54 @@ export namespace aiplatform_v1 { * @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$Notebookruntimetemplates$Operations$List, + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + rawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, + ): Promise>; + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List, - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + rawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + callback: BodyResponseCallback ): void; - list( + rawPredict(callback: BodyResponseCallback): void; + rawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$List; + {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; options = {}; } @@ -125144,34 +142789,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Perform a server-side streaming online prediction request for Vertex LLM streaming. * @example * ```js * // Before running the sample: @@ -125192,7 +142835,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125201,23 +142847,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.notebookRuntimeTemplates.operations.wait( + * await aiplatform.projects.locations.publishers.models.serverStreamingPredict( * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/notebookRuntimeTemplates/my-notebookRuntimeTemplate/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [], + * // "parameters": {} + * // } + * }, * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [], + * // "parameters": {} * // } * } * @@ -125233,58 +142884,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + serverStreamingPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait, - callback: BodyResponseCallback + serverStreamingPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + serverStreamingPredict( + callback: BodyResponseCallback ): void; - wait( + serverStreamingPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait; + {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; options = {}; } @@ -125297,87 +142952,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Generate content with multimodal inputs with streaming support. * @example * ```js * // Before running the sample: @@ -125398,7 +143000,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125406,14 +143011,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.streamGenerateContent( + * { + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } * } * * main().catch(e => { @@ -125428,53 +143060,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + streamGenerateContent( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + streamGenerateContent( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + streamGenerateContent( + callback: BodyResponseCallback + ): void; + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; options = {}; } @@ -125487,29 +143128,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Perform a streaming online prediction with an arbitrary HTTP payload. * @example * ```js * // Before running the sample: @@ -125530,7 +143176,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125538,14 +143187,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.streamRawPredict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "httpBody": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -125560,53 +143223,56 @@ export namespace aiplatform_v1 { * @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$Operations$Delete, + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + streamRawPredict( + params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): Promise>; + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + streamRawPredict( + params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + streamRawPredict( + callback: BodyResponseCallback + ): void; + streamRawPredict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; options = {}; } @@ -125619,29 +143285,161 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Required. The name of the Endpoint requested to get lists of tokens and token ids. + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens extends StandardParameters { + /** + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Embedcontent extends StandardParameters { + /** + * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1EmbedContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Predict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; + } + + export class Resource$Projects$Locations$Publishers$Models$Invoke { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example * ```js * // Before running the sample: @@ -125662,7 +143460,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125670,19 +143471,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.publishers.models.invoke.invoke({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * + * invokeId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "deployedModelId": "my_deployedModelId", + * // "httpBody": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -125698,57 +143510,54 @@ export namespace aiplatform_v1 { * @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$Operations$Get, + invoke( + params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + invoke( + params?: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): Promise>; + invoke( + params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + invoke( + params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + invoke( + params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, + callback: BodyResponseCallback ): void; - get( + invoke(callback: BodyResponseCallback): void; + invoke( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke; options = {}; } @@ -125761,29 +143570,59 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint', 'invokeId'], + pathParams: ['endpoint', 'invokeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke extends StandardParameters { + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + /** + * + */ + invokeId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; + } + + export class Resource$Projects$Locations$Publishers$V1 { + context: APIRequestContext; + responses: Resource$Projects$Locations$Publishers$V1$Responses; + constructor(context: APIRequestContext) { + this.context = context; + this.responses = new Resource$Projects$Locations$Publishers$V1$Responses( + this.context + ); + } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example * ```js * // Before running the sample: @@ -125804,7 +143643,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125812,25 +143654,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.projects.locations.publishers.v1.responses({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -125846,61 +143693,54 @@ export namespace aiplatform_v1 { * @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$Operations$List, + responses( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + responses( + params?: Params$Resource$Projects$Locations$Publishers$V1$Responses, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): Promise>; + responses( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + responses( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + responses( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses, + callback: BodyResponseCallback ): void; - list( + responses(callback: BodyResponseCallback): void; + responses( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$V1$Responses + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Publishers$V1$Responses; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Publishers$V1$Responses; options = {}; } @@ -125913,34 +143753,55 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+endpoint}/v1/responses').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Publishers$V1$Responses extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * ID of the DeployedModel that serves the invoke request. + */ + deployedModelId?: string; + /** + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleApiHttpBody; + } + + export class Resource$Projects$Locations$Publishers$V1$Responses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. * @example * ```js * // Before running the sample: @@ -125961,7 +143822,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -125969,21 +143833,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.publishers.v1.responses.compact({ + * // ID of the DeployedModel that serves the invoke request. + * deployedModelId: 'placeholder-value', + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: + * 'projects/my-project/locations/my-location/publishers/my-publisher', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -125999,57 +143873,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + compact( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Operations$Wait, + compact( + params?: Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, + ): Promise>; + compact( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Operations$Wait, - callback: BodyResponseCallback + compact( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + compact( + params: Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact, + callback: BodyResponseCallback ): void; - wait( + compact(callback: BodyResponseCallback): void; + compact( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Wait; + params = + {} as Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact; options = {}; } @@ -126062,92 +143933,63 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}/v1/responses/compact').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$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; + export interface Params$Resource$Projects$Locations$Publishers$V1$Responses$Compact extends StandardParameters { /** - * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * ID of the DeployedModel that serves the invoke request. */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Operations$Wait extends StandardParameters { + deployedModelId?: string; /** - * The name of the operation resource to wait on. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - name?: string; + endpoint?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleApiHttpBody; } - export class Resource$Projects$Locations$Persistentresources { + export class Resource$Projects$Locations$Ragcorpora { context: APIRequestContext; - operations: Resource$Projects$Locations$Persistentresources$Operations; + operations: Resource$Projects$Locations$Ragcorpora$Operations; + ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Persistentresources$Operations( - this.context - ); + this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( + this.context + ); + this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( + this.context + ); } /** - * Creates a PersistentResource. + * Creates a RagCorpus. * @example * ```js * // Before running the sample: @@ -126176,33 +144018,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.create({ - * // Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.ragCorpora.create({ + * // Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * // Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - * persistentResourceId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "corpusStatus": {}, * // "createTime": "my_createTime", + * // "description": "my_description", * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "error": {}, - * // "labels": {}, * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} * // } * }, * }); @@ -126231,27 +144065,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Persistentresources$Create, + params?: Params$Resource$Projects$Locations$Ragcorpora$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + params: Params$Resource$Projects$Locations$Ragcorpora$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Persistentresources$Create, + params: Params$Resource$Projects$Locations$Ragcorpora$Create, callback: BodyResponseCallback ): void; create( @@ -126259,7 +144092,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Create + | Params$Resource$Projects$Locations$Ragcorpora$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126275,13 +144108,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Create; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Create; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; options = {}; } @@ -126294,7 +144126,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), @@ -126319,7 +144151,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a PersistentResource. + * Deletes a RagCorpus. * @example * ```js * // Before running the sample: @@ -126348,9 +144180,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.delete({ - * // Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * const res = await aiplatform.projects.locations.ragCorpora.delete({ + * // Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + * force: 'placeholder-value', + * // Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * @@ -126377,27 +144211,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Delete, + params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Persistentresources$Delete, + params: Params$Resource$Projects$Locations$Ragcorpora$Delete, callback: BodyResponseCallback ): void; delete( @@ -126405,7 +144238,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126421,13 +144254,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Delete; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; options = {}; } @@ -126462,7 +144294,7 @@ export namespace aiplatform_v1 { } /** - * Gets a PersistentResource. + * Gets a RagCorpus. * @example * ```js * // Before running the sample: @@ -126491,31 +144323,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.get({ - * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', + * const res = await aiplatform.projects.locations.ragCorpora.get({ + * // Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * * // Example response * // { + * // "corpusStatus": {}, * // "createTime": "my_createTime", + * // "description": "my_description", * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "error": {}, - * // "labels": {}, * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} * // } * } * @@ -126532,61 +144358,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Persistentresources$Get, + params?: Params$Resource$Projects$Locations$Ragcorpora$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, + params: Params$Resource$Projects$Locations$Ragcorpora$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Persistentresources$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Get + | 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$Persistentresources$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Get; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; options = {}; } @@ -126611,19 +144436,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists PersistentResources in a Location. + * Lists RagCorpora in a Location. * @example * ```js * // Before running the sample: @@ -126652,12 +144477,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.list({ - * // Optional. The standard list page size. + * const res = await aiplatform.projects.locations.ragCorpora.list({ + * // Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. + * // Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` + * // Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); @@ -126665,7 +144490,7 @@ export namespace aiplatform_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "persistentResources": [] + * // "ragCorpora": [] * // } * } * @@ -126682,61 +144507,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Persistentresources$List, + params?: Params$Resource$Projects$Locations$Ragcorpora$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, + params: Params$Resource$Projects$Locations$Ragcorpora$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Persistentresources$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Ragcorpora$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$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$Persistentresources$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$List; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; options = {}; } @@ -126749,7 +144573,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/persistentResources').replace( + url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( /([^:]\/)\/+/g, '$1' ), @@ -126764,19 +144588,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a PersistentResource. + * Updates a RagCorpus. * @example * ```js * // Before running the sample: @@ -126805,33 +144629,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.patch({ - * // Immutable. Resource name of a PersistentResource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * // Required. Specify the fields to be overwritten in the PersistentResource by the update method. - * updateMask: 'placeholder-value', + * const res = await aiplatform.projects.locations.ragCorpora.patch({ + * // Output only. The resource name of the RagCorpus. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "corpusStatus": {}, * // "createTime": "my_createTime", + * // "description": "my_description", * // "displayName": "my_displayName", * // "encryptionSpec": {}, - * // "error": {}, - * // "labels": {}, * // "name": "my_name", - * // "network": "my_network", - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "resourcePools": [], - * // "resourceRuntime": {}, - * // "resourceRuntimeSpec": {}, * // "satisfiesPzi": false, * // "satisfiesPzs": false, - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "updateTime": "my_updateTime", + * // "vectorDbConfig": {}, + * // "vertexAiSearchConfig": {} * // } * }, * }); @@ -126860,27 +144676,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Persistentresources$Patch, + params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, options?: MethodOptions ): Promise>; patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Persistentresources$Patch, + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, callback: BodyResponseCallback ): void; patch( @@ -126888,7 +144703,7 @@ export namespace aiplatform_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Patch + | Params$Resource$Projects$Locations$Ragcorpora$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -126904,13 +144719,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Patch; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Persistentresources$Patch; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; options = {}; } @@ -126943,9 +144757,69 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Create extends StandardParameters { /** - * Reboots a PersistentResource. + * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Delete extends StandardParameters { + /** + * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. + */ + force?: boolean; + /** + * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Get extends StandardParameters { + /** + * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$List extends StandardParameters { + /** + * Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Patch extends StandardParameters { + /** + * Output only. The resource name of the RagCorpus. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; + } + + export class Resource$Projects$Locations$Ragcorpora$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -126974,26 +144848,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.persistentResources.reboot({ - * // Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.locations.ragCorpora.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -127008,58 +144870,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions ): Promise>; - reboot( - params?: Params$Resource$Projects$Locations$Persistentresources$Reboot, + cancel( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options?: MethodOptions - ): Promise>; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reboot( - params: Params$Resource$Projects$Locations$Persistentresources$Reboot, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reboot( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + callback: BodyResponseCallback ): void; - reboot( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Reboot - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Reboot; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Reboot; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; options = {}; } @@ -127072,7 +144930,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:reboot').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -127084,92 +144942,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Persistentresources$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the PersistentResource in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Required. The ID to use for the PersistentResource, which become the final component of the PersistentResource's resource name. The maximum length is 63 characters, and valid characters are `/^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$/`. - */ - persistentResourceId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Delete extends StandardParameters { - /** - * Required. The name of the PersistentResource to be deleted. Format: `projects/{project\}/locations/{location\}/persistentResources/{persistent_resource\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Get extends StandardParameters { - /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$List extends StandardParameters { - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListPersistentResourcesResponse.next_page_token of the previous PersistentResourceService.ListPersistentResource call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the PersistentResources from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Patch extends StandardParameters { - /** - * Immutable. Resource name of a PersistentResource. - */ - name?: string; - /** - * Required. Specify the fields to be overwritten in the PersistentResource by the update method. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PersistentResource; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Reboot extends StandardParameters { - /** - * Required. The name of the PersistentResource resource. Format: `projects/{project_id_or_number\}/locations/{location_id\}/persistentResources/{persistent_resource_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RebootPersistentResourceRequest; - } - - export class Resource$Projects$Locations$Persistentresources$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -127198,11 +144981,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -127221,32 +145003,32 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127262,13 +145044,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; options = {}; } @@ -127281,8 +145063,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -127303,7 +145085,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -127332,15 +145114,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -127355,54 +145142,57 @@ export namespace aiplatform_v1 { * @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$Persistentresources$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; options = {}; } @@ -127416,7 +145206,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -127427,17 +145217,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -127466,11 +145256,170 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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$Ragcorpora$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.ragCorpora.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -127495,36 +145444,35 @@ export namespace aiplatform_v1 { * @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$Persistentresources$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + ): Promise>; + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, callback: BodyResponseCallback ): void; - get( + wait( callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Get + | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -127540,13 +145488,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; options = {}; } @@ -127559,8 +145507,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -127579,9 +145527,72 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( + this.context + ); + } + + /** + * Deletes a RagFile. * @example * ```js * // Before running the sample: @@ -127610,26 +145621,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.delete({ + * // Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. + * forceDelete: 'placeholder-value', + * // Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -127645,62 +145651,57 @@ export namespace aiplatform_v1 { * @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$Persistentresources$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$List; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; options = {}; } @@ -127713,11 +145714,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -127728,19 +145726,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets a RagFile. * @example * ```js * // Before running the sample: @@ -127769,22 +145765,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.persistentResources.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/persistentResources/my-persistentResource/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.get({ + * // Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "directUploadSource": {}, + * // "displayName": "my_displayName", + * // "fileStatus": {}, + * // "gcsSource": {}, + * // "googleDriveSource": {}, + * // "jiraSource": {}, * // "name": "my_name", - * // "response": {} + * // "sharePointSources": {}, + * // "slackSource": {}, + * // "updateTime": "my_updateTime", + * // "userMetadata": "my_userMetadata" * // } * } * @@ -127800,58 +145801,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Persistentresources$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Persistentresources$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Persistentresources$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; options = {}; } @@ -127864,8 +145865,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -127876,79 +145877,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Persistentresources$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Persistentresources$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Pipelinejobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Pipelinejobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Pipelinejobs$Operations( - this.context - ); - } /** - * Batch cancel PipelineJobs. Firstly the server will check if all the jobs are in non-terminal states, and skip the jobs that are already terminated. If the operation failed, none of the pipeline jobs are cancelled. The server will poll the states of all the pipeline jobs periodically to check the cancellation status. This operation will return an LRO. + * Import files from Google Cloud Storage or Google Drive into a RagCorpus. * @example * ```js * // Before running the sample: @@ -127977,15 +145918,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.batchCancel({ - * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.import({ + * // Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "names": [] + * // "importRagFilesConfig": {} * // } * }, * }); @@ -128013,36 +145954,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions ): Promise>; - batchCancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + import( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options?: MethodOptions ): Promise>; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel, + import( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, callback: BodyResponseCallback ): void; - batchCancel( + import( callback: BodyResponseCallback ): void; - batchCancel( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -128058,13 +145998,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; options = {}; } @@ -128077,7 +146017,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchCancel').replace( + url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -128102,7 +146042,7 @@ export namespace aiplatform_v1 { } /** - * Batch deletes PipelineJobs The Operation is atomic. If it fails, none of the PipelineJobs are deleted. If it succeeds, all of the PipelineJobs are deleted. + * Lists RagFiles in a RagCorpus. * @example * ```js * // Before running the sample: @@ -128131,27 +146071,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.batchDelete({ - * // Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "names": [] - * // } - * }, + * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.list({ + * // Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "ragFiles": [] * // } * } * @@ -128167,58 +146100,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions ): Promise>; - batchDelete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options?: MethodOptions - ): Promise>; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchDelete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete; + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; options = {}; } @@ -128231,11 +146168,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs:batchDelete').replace( + url: (rootUrl + '/v1/{+parent}/ragFiles').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -128246,17 +146183,68 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete extends StandardParameters { /** - * Cancels a PipelineJob. Starts asynchronous cancellation on the PipelineJob. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetPipelineJob or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the PipelineJob is not deleted; instead it becomes a pipeline with a PipelineJob.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and PipelineJob.state is set to `CANCELLED`. + * Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. + */ + forceDelete?: boolean; + /** + * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get extends StandardParameters { + /** + * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import extends StandardParameters { + /** + * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List extends StandardParameters { + /** + * Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. + */ + pageToken?: string; + /** + * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -128285,16 +146273,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.cancel({ - * // Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -128314,31 +146297,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Cancel, + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Cancel + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -128354,12 +146337,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Cancel; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -128394,7 +146378,7 @@ export namespace aiplatform_v1 { } /** - * Creates a PipelineJob. A PipelineJob will run immediately when created. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -128423,66 +146407,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.create({ - * // Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. - * pipelineJobId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -128497,61 +146430,54 @@ export namespace aiplatform_v1 { * @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$Pipelinejobs$Create, + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Create, + delete( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Pipelinejobs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Create; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Create; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -128564,34 +146490,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a PipelineJob. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -128620,10 +146541,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.delete({ - * // Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', - * }); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -128648,36 +146570,35 @@ export namespace aiplatform_v1 { * @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$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Delete, + get( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Delete + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -128693,12 +146614,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Delete; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -128712,7 +146634,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -128733,7 +146655,7 @@ export namespace aiplatform_v1 { } /** - * Gets a PipelineJob. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -128762,35 +146684,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.get({ - * // Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', - * }); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "jobDetail": {}, - * // "labels": {}, - * // "name": "my_name", - * // "network": "my_network", - * // "pipelineSpec": {}, - * // "preflightValidations": false, - * // "pscInterfaceConfig": {}, - * // "reservedIpRanges": [], - * // "runtimeConfig": {}, - * // "scheduleName": "my_scheduleName", - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "templateMetadata": {}, - * // "templateUri": "my_templateUri", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -128806,61 +146719,62 @@ export namespace aiplatform_v1 { * @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$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$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$Pipelinejobs$Get; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$Get; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -128873,7 +146787,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -128885,19 +146802,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists PipelineJobs in a Location. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -128926,26 +146843,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.list({ - * // Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` - * orderBy: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "pipelineJobs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -128961,61 +146874,57 @@ export namespace aiplatform_v1 { * @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$Pipelinejobs$List, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$List, + wait( + params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Pipelinejobs$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$List; + {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pipelinejobs$List; + params = + {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -129028,121 +146937,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pipelineJobs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchcancel extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCancelPipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Batchdelete extends StandardParameters { - /** - * Required. The name of the PipelineJobs' parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchDeletePipelineJobsRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** - * Required. The name of the PipelineJob to cancel. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource to be cancelled. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelPipelineJobRequest; - } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/a-z-/`. - */ - pipelineJobId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PipelineJob; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** - * Required. The name of the PipelineJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** - * Required. The name of the PipelineJob resource. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** - * Lists the PipelineJobs that match the filter expression. The following fields are supported: * `pipeline_name`: Supports `=` and `!=` comparisons. * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `pipeline_job_user_id`: Supports `=`, `!=` comparisons, and `:` wildcard. for example, can check if pipeline's display_name contains *step* by doing display_name:\"*step*\" * `state`: Supports `=` and `!=` comparisons. * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. * `template_uri`: Supports `=`, `!=` comparisons, and `:` wildcard. * `template_metadata.version`: Supports `=`, `!=` comparisons, and `:` wildcard. Filter expressions can be combined together using logical operators (`AND` & `OR`). For example: `pipeline_name="test" AND create_time\>"2020-05-18T13:30:00Z"`. The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `create_time\>"2021-05-18T00:00:00Z" OR update_time\>"2020-05-18T00:00:00Z"` PipelineJobs created or updated after 2020-05-18 00:00:00 UTC. * `labels.env = "prod"` PipelineJobs with label "env" set to "prod". + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided e.g. "create_time desc, end_time", "end_time, start_time, update_time" For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple jobs having the same create time, order them by the end time in ascending order. if order_by is not specified, it will order by default order is create time in descending order. Supported fields: * `create_time` * `update_time` * `end_time` * `start_time` + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListPipelineJobsResponse.next_page_token of the previous PipelineService.ListPipelineJobs call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list the PipelineJobs from. Format: `projects/{project\}/locations/{location\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** - * Mask specifying which fields to read. + * The name of the operation resource to wait on. */ - readMask?: string; + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Pipelinejobs$Operations { + export class Resource$Projects$Locations$Ragengineconfig { + context: APIRequestContext; + operations: Resource$Projects$Locations$Ragengineconfig$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Ragengineconfig$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Ragengineconfig$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -129179,9 +147059,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.pipelineJobs.operations.cancel({ + * await aiplatform.projects.locations.ragEngineConfig.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -129202,31 +147082,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129242,13 +147122,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; options = {}; } @@ -129313,9 +147193,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.pipelineJobs.operations.delete({ + * await aiplatform.projects.locations.ragEngineConfig.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -129336,31 +147216,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129376,13 +147256,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; options = {}; } @@ -129446,10 +147326,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.ragEngineConfig.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -129475,27 +147356,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -129503,7 +147383,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129519,13 +147399,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; options = {}; } @@ -129589,18 +147469,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.ragEngineConfig.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -129624,29 +147505,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$List, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, callback: BodyResponseCallback ): void; list( @@ -129654,7 +147535,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$List + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129672,13 +147553,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$List; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; options = {}; } @@ -129747,12 +147628,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.pipelineJobs.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/pipelineJobs/my-pipelineJob/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.ragEngineConfig.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -129778,27 +147660,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait, + params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -129806,7 +147687,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait + | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -129822,13 +147703,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; options = {}; } @@ -129863,25 +147744,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -129903,7 +147784,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Pipelinejobs$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -129914,189 +147795,47 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Publishers { - context: APIRequestContext; - models: Resource$Projects$Locations$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Projects$Locations$Publishers$Models( - this.context - ); - } - } - - export class Resource$Projects$Locations$Publishers$Models { + export class Resource$Projects$Locations$Reasoningengines { context: APIRequestContext; - invoke: Resource$Projects$Locations$Publishers$Models$Invoke; + memories: Resource$Projects$Locations$Reasoningengines$Memories; + operations: Resource$Projects$Locations$Reasoningengines$Operations; + runtimeRevisions: Resource$Projects$Locations$Reasoningengines$Runtimerevisions; + sandboxEnvironments: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments; + sandboxEnvironmentSnapshots: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots; + sandboxEnvironmentTemplates: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates; + sessions: Resource$Projects$Locations$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; - this.invoke = new Resource$Projects$Locations$Publishers$Models$Invoke( + this.memories = new Resource$Projects$Locations$Reasoningengines$Memories( this.context ); - } - - /** - * Return a list of tokens based on the input text. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.publishers.models.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "tokensInfo": [] - * // } - * } - * - * 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. - */ - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - options: StreamMethodOptions - ): Promise>; - computeTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Computetokens, - callback: BodyResponseCallback - ): void; - computeTokens( - callback: BodyResponseCallback - ): void; - computeTokens( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Computetokens - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Computetokens; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + this.operations = + new Resource$Projects$Locations$Reasoningengines$Operations( + this.context ); - } else { - return createAPIRequest( - parameters + this.runtimeRevisions = + new Resource$Projects$Locations$Reasoningengines$Runtimerevisions( + this.context ); - } + this.sandboxEnvironments = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments( + this.context + ); + this.sandboxEnvironmentSnapshots = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots( + this.context + ); + this.sandboxEnvironmentTemplates = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates( + this.context + ); + this.sessions = new Resource$Projects$Locations$Reasoningengines$Sessions( + this.context + ); } /** - * Perform a token counting. + * Async query using a reasoning engine. * @example * ```js * // Before running the sample: @@ -130125,33 +147864,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.countTokens( - * { - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.reasoningEngines.asyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputGcsUri": "my_inputGcsUri", + * // "outputGcsUri": "my_outputGcsUri" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -130167,62 +147901,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + asyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, options: StreamMethodOptions ): Promise>; - countTokens( - params?: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + asyncQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + ): Promise>; + asyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, + asyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - countTokens( - params: Params$Resource$Projects$Locations$Publishers$Models$Counttokens, - callback: BodyResponseCallback + asyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, + callback: BodyResponseCallback ): void; - countTokens( - callback: BodyResponseCallback + asyncQuery( + callback: BodyResponseCallback ): void; - countTokens( + asyncQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Counttokens - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Asyncquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Asyncquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Counttokens; + {} as Params$Resource$Projects$Locations$Reasoningengines$Asyncquery; options = {}; } @@ -130235,7 +147964,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + url: (rootUrl + '/v1/{+name}:asyncQuery').replace( /([^:]\/)\/+/g, '$1' ), @@ -130245,24 +147974,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Embed content with multimodal inputs. + * Cancels an AsyncQueryReasoningEngine operation. * @example * ```js * // Before running the sample: @@ -130283,10 +148010,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -130295,32 +148019,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.publishers.models.embedContent({ - * // Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` - * model: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * await aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "autoTruncate": false, - * // "content": {}, - * // "embedContentConfig": {}, - * // "outputDimensionality": 0, - * // "taskType": "my_taskType", - * // "title": "my_title" + * // "operationName": "my_operationName" * // } * }, * }); * console.log(res.data); * * // Example response - * // { - * // "embedding": {}, - * // "truncated": false, - * // "usageMetadata": {} - * // } + * // {} * } * * main().catch(e => { @@ -130335,62 +148049,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - embedContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, options: StreamMethodOptions ): Promise>; - embedContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + cancelAsyncQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - embedContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - embedContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - embedContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Embedcontent, - callback: BodyResponseCallback + cancelAsyncQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + callback: BodyResponseCallback ): void; - embedContent( - callback: BodyResponseCallback + cancelAsyncQuery( + callback: BodyResponseCallback ): void; - embedContent( + cancelAsyncQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Embedcontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery + | 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$Publishers$Models$Embedcontent; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Embedcontent; + {} as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; options = {}; } @@ -130403,7 +148117,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:embedContent').replace( + url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( /([^:]\/)\/+/g, '$1' ), @@ -130413,24 +148127,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Fetch an asynchronous online prediction operation. + * Creates a reasoning engine. * @example * ```js * // Before running the sample: @@ -130451,10 +148165,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -130462,22 +148173,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.fetchPredictOperation( - * { - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.reasoningEngines.create({ + * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -130502,36 +148218,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Create, options?: MethodOptions ): Promise>; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Create, callback: BodyResponseCallback ): void; - fetchPredictOperation( + create( callback: BodyResponseCallback ): void; - fetchPredictOperation( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation + | Params$Resource$Projects$Locations$Reasoningengines$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -130547,13 +148262,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation; + {} as Params$Resource$Projects$Locations$Reasoningengines$Create; options = {}; } @@ -130566,7 +148281,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), @@ -130576,8 +148291,8 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -130591,7 +148306,7 @@ export namespace aiplatform_v1 { } /** - * Generate content with multimodal inputs. + * Deletes a reasoning engine. * @example * ```js * // Before running the sample: @@ -130612,10 +148327,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -130623,38 +148335,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.reasoningEngines.delete({ + * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * force: 'placeholder-value', + * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -130670,62 +148365,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - generateContent( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Generatecontent; + {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; options = {}; } @@ -130738,33 +148428,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Executes code statelessly. * @example * ```js * // Before running the sample: @@ -130785,10 +148471,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -130796,18 +148479,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.reasoningEngines.executeCode({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} + * // "inputs": [] * // } * }, * }); @@ -130815,12 +148495,7 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", - * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "outputs": [] * // } * } * @@ -130836,62 +148511,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predict, + executeCode( + params?: Params$Resource$Projects$Locations$Reasoningengines$Executecode, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Projects$Locations$Publishers$Models$Predict, - callback: BodyResponseCallback + executeCode( + params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + executeCode( + callback: BodyResponseCallback ): void; - predict( + executeCode( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Executecode + | 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$Publishers$Models$Predict; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Executecode; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predict; + {} as Params$Resource$Projects$Locations$Reasoningengines$Executecode; options = {}; } @@ -130904,7 +148579,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( + url: (rootUrl + '/v1/{+name}:executeCode').replace( /([^:]\/)\/+/g, '$1' ), @@ -130914,23 +148589,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** + * Gets a reasoning engine. * @example * ```js * // Before running the sample: @@ -130951,10 +148627,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -130962,31 +148635,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, - * }); + * const res = await aiplatform.projects.locations.reasoningEngines.get({ + * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "spec": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -131002,58 +148668,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Get, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Get, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - predictLongRunning( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; options = {}; } @@ -131066,32 +148735,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Perform an online prediction with an arbitrary HTTP payload. The response includes the following HTTP headers: * `X-Vertex-AI-Endpoint-Id`: ID of the Endpoint that served this prediction. * `X-Vertex-AI-Deployed-Model-Id`: ID of the Endpoint's DeployedModel that served this prediction. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @example * ```js * // Before running the sample: @@ -131112,10 +148780,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -131123,26 +148788,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.publishers.models.rawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } + * const res = await aiplatform.projects.locations.reasoningEngines.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/locations/my-location/reasoningEngines/my-reasoningEngine', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -131158,54 +148819,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + getIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, options: StreamMethodOptions ): Promise>; - rawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, options?: MethodOptions - ): Promise>; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, + ): Promise>; + getIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Rawpredict, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, + callback: BodyResponseCallback ): void; - rawPredict(callback: BodyResponseCallback): void; - rawPredict( + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Rawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Rawpredict; + {} as Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy; options = {}; } @@ -131218,7 +148881,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:rawPredict').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -131228,22 +148891,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Perform a server-side streaming online prediction request for Vertex LLM streaming. + * Lists reasoning engines in a location. * @example * ```js * // Before running the sample: @@ -131264,10 +148927,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -131275,29 +148935,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.serverStreamingPredict( - * { - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [], - * // "parameters": {} - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.reasoningEngines.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [], - * // "parameters": {} + * // "nextPageToken": "my_nextPageToken", + * // "reasoningEngines": [] * // } * } * @@ -131313,62 +148966,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions ): Promise>; - serverStreamingPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$List, + callback: BodyResponseCallback ): void; - serverStreamingPredict( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - serverStreamingPredict( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$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$Publishers$Models$Serverstreamingpredict; + {}) as Params$Resource$Projects$Locations$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict; + params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; options = {}; } @@ -131381,34 +149033,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:serverStreamingPredict').replace( + url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Generate content with multimodal inputs with streaming support. + * Updates a reasoning engine. * @example * ```js * // Before running the sample: @@ -131429,10 +149081,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -131440,40 +149089,38 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.streamGenerateContent( - * { - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.reasoningEngines.patch({ + * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // Optional. Mask specifying which fields to update. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, - * }, - * ); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -131489,62 +149136,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - streamGenerateContent( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent; + {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; options = {}; } @@ -131557,34 +149199,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Perform a streaming online prediction with an arbitrary HTTP payload. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -131605,10 +149242,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -131616,27 +149250,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.streamRawPredict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', + * const res = await aiplatform.projects.locations.reasoningEngines.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "httpBody": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "output": {} * // } * } * @@ -131652,56 +149283,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, options: StreamMethodOptions ): Promise>; - streamRawPredict( - params?: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + query( + params?: Params$Resource$Projects$Locations$Reasoningengines$Query, options?: MethodOptions - ): Promise>; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamRawPredict( - params: Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Query, + callback: BodyResponseCallback ): void; - streamRawPredict( - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - streamRawPredict( + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict; + {} as Params$Resource$Projects$Locations$Reasoningengines$Query; options = {}; } @@ -131714,161 +149351,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:streamRawPredict').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Publishers$Models$Computetokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Counttokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Embedcontent extends StandardParameters { - /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1EmbedContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Fetchpredictoperation extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Predict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Predictlongrunning extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Rawpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RawPredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Serverstreamingpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamingPredictRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; - } - export interface Params$Resource$Projects$Locations$Publishers$Models$Streamrawpredict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamRawPredictRequest; - } - - export class Resource$Projects$Locations$Publishers$Models$Invoke { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @example * ```js * // Before running the sample: @@ -131889,10 +149396,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -131900,30 +149404,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.publishers.models.invoke.invoke({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: - * 'projects/my-project/locations/my-location/publishers/my-publisher/models/my-model', - * - * invokeId: 'placeholder-value', + * const res = await aiplatform.projects.locations.reasoningEngines.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/locations/my-location/reasoningEngines/my-reasoningEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "deployedModelId": "my_deployedModelId", - * // "httpBody": {} + * // "policy": {} * // } * }, - * }); + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "bindings": [], + * // "etag": "my_etag", + * // "version": 0 * // } * } * @@ -131939,54 +149441,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - invoke( - params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, + setIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, options: StreamMethodOptions ): Promise>; - invoke( - params?: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, options?: MethodOptions - ): Promise>; - invoke( - params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, + ): Promise>; + setIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - invoke( - params: Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, + callback: BodyResponseCallback ): void; - invoke(callback: BodyResponseCallback): void; - invoke( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke; + {} as Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy; options = {}; } @@ -131999,7 +149503,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}/invoke/{+invokeId}').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -132009,53 +149513,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['endpoint', 'invokeId'], - pathParams: ['endpoint', 'invokeId'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Publishers$Models$Invoke$Invoke extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - /** - * - */ - invokeId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1InvokeRequest; - } - - export class Resource$Projects$Locations$Ragcorpora { - context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Operations; - ragFiles: Resource$Projects$Locations$Ragcorpora$Ragfiles; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Ragcorpora$Operations( - this.context - ); - this.ragFiles = new Resource$Projects$Locations$Ragcorpora$Ragfiles( - this.context - ); + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a RagCorpus. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -132084,25 +149557,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.create({ - * // Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.reasoningEngines.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} + * // "classMethod": "my_classMethod", + * // "input": {} * // } * }, * }); @@ -132110,11 +149574,9 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -132130,57 +149592,54 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Create, + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Ragcorpora$Create, + streamQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, + ): Promise>; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Ragcorpora$Create, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - create( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Create; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; options = {}; } @@ -132193,7 +149652,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( + url: (rootUrl + '/v1/{+name}:streamQuery').replace( /([^:]\/)\/+/g, '$1' ), @@ -132203,22 +149662,22 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a RagCorpus. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @example * ```js * // Before running the sample: @@ -132247,21 +149706,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.delete({ - * // Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. - * force: 'placeholder-value', - * // Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.testIamPermissions({ + * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * permissions: 'placeholder-value', + * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * resource: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "permissions": [] * // } * } * @@ -132277,57 +149734,62 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + testIamPermissions( + params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Delete; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions; options = {}; } @@ -132340,29 +149802,198 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Asyncquery extends StandardParameters { /** - * Gets a RagCorpus. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Delete extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Executecode extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Get extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$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$Locations$Reasoningengines$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Patch extends StandardParameters { + /** + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + /** + * Optional. Mask specifying which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Query extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$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$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions extends StandardParameters { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[]; + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Memories { + context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Memories$Operations; + revisions: Resource$Projects$Locations$Reasoningengines$Memories$Revisions; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Memories$Operations( + this.context + ); + this.revisions = + new Resource$Projects$Locations$Reasoningengines$Memories$Revisions( + this.context + ); + } + + /** + * Create a Memory. * @example * ```js * // Before running the sample: @@ -132391,25 +150022,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.get({ - * // Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.create({ + * // Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. + * memoryId: 'placeholder-value', + * // Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", + * // "metadata": {}, + * // "name": "my_name", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} + * // "response": {} * // } * } * @@ -132425,61 +150076,57 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Get, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Get; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Create; options = {}; } @@ -132492,31 +150139,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/memories').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists RagCorpora in a Location. + * Delete a Memory. * @example * ```js * // Before running the sample: @@ -132545,20 +150193,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.list({ - * // Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.delete({ + * // Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "ragCorpora": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -132574,61 +150222,57 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$List, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$List; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete; options = {}; } @@ -132641,34 +150285,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragCorpora').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a RagCorpus. + * Generate memories. * @example * ```js * // Before running the sample: @@ -132697,28 +150336,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.patch({ - * // Output only. The resource name of the RagCorpus. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.generate({ + * // Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "corpusStatus": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "name": "my_name", - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime", - * // "vectorDbConfig": {}, - * // "vertexAiSearchConfig": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowedTopics": [], + * // "directContentsSource": {}, + * // "directMemoriesSource": {}, + * // "disableConsolidation": false, + * // "disableMemoryRevisions": false, + * // "metadata": {}, + * // "metadataMergeStrategy": "my_metadataMergeStrategy", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "vertexSessionSource": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -132743,36 +150385,35 @@ export namespace aiplatform_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$Ragcorpora$Patch, + generate( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, + generate( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + generate( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + generate( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + generate( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, callback: BodyResponseCallback ): void; - patch( + generate( callback: BodyResponseCallback ): void; - patch( + generate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Patch + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -132788,12 +150429,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Ragcorpora$Patch; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate; options = {}; } @@ -132806,15 +150448,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/memories:generate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -132826,69 +150471,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the RagCorpus in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Delete extends StandardParameters { - /** - * Optional. If set to true, any RagFiles in this RagCorpus will also be deleted. Otherwise, the request will only work if the RagCorpus has no RagFiles. - */ - force?: boolean; - /** - * Required. The name of the RagCorpus resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Get extends StandardParameters { - /** - * Required. The name of the RagCorpus resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$List extends StandardParameters { - /** - * Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location from which to list the RagCorpora. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Patch extends StandardParameters { - /** - * Output only. The resource name of the RagCorpus. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RagCorpus; - } - - export class Resource$Projects$Locations$Ragcorpora$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Get a Memory. * @example * ```js * // Before running the sample: @@ -132917,14 +150502,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.reasoningEngines.memories.get( + * { + * // Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", + * // "metadata": {}, + * // "name": "my_name", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -132939,54 +150542,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Get; options = {}; } @@ -132999,8 +150606,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -133011,17 +150618,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Ingests events for a Memory Bank. * @example * ```js * // Before running the sample: @@ -133050,14 +150659,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.ingestEvents({ + * // Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "directContentsSource": {}, + * // "disableMemoryRevisions": false, + * // "forceFlush": false, + * // "generationTriggerConfig": {}, + * // "metadata": {}, + * // "metadataMergeStrategy": "my_metadataMergeStrategy", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "streamId": "my_streamId" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -133072,54 +150707,57 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Operations$Delete, + ingestEvents( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + ingestEvents( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, + ): Promise>; + ingestEvents( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ingestEvents( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete, - callback: BodyResponseCallback + ingestEvents( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + ingestEvents( + callback: BodyResponseCallback + ): void; + ingestEvents( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents; options = {}; } @@ -133132,29 +150770,32 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/memories:ingestEvents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * List Memories. * @example * ```js * // Before running the sample: @@ -133183,19 +150824,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) + * filter: 'placeholder-value', + * // Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` + * orderBy: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "memories": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -133211,58 +150859,62 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$List; options = {}; } @@ -133275,29 +150927,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/memories').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Update a Memory. * @example * ```js * // Before running the sample: @@ -133326,25 +150983,44 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.patch({ + * // Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * // Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "disableMemoryRevisions": false, + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "fact": "my_fact", + * // "metadata": {}, + * // "name": "my_name", + * // "revisionExpireTime": "my_revisionExpireTime", + * // "revisionLabels": {}, + * // "revisionTtl": "my_revisionTtl", + * // "scope": {}, + * // "topics": [], + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -133360,62 +151036,57 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch; options = {}; } @@ -133428,11 +151099,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -133443,19 +151111,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Purge memories. * @example * ```js * // Before running the sample: @@ -133484,12 +151150,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.purge({ + * // Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "filterGroups": [], + * // "force": false + * // } + * }, + * }); * console.log(res.data); * * // Example response @@ -133514,36 +151190,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + purge( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + purge( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + purge( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + purge( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait, + purge( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, callback: BodyResponseCallback ): void; - wait( + purge( callback: BodyResponseCallback ): void; - wait( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -133559,13 +151234,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge; options = {}; } @@ -133578,15 +151253,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/memories:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -133598,72 +151276,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Ragcorpora$Ragfiles { - context: APIRequestContext; - operations: Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations( - this.context - ); - } /** - * Deletes a RagFile. + * Retrieve memories. * @example * ```js * // Before running the sample: @@ -133692,21 +151307,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.delete({ - * // Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. - * forceDelete: 'placeholder-value', - * // Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.retrieve({ + * // Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "filterGroups": [], + * // "memoryTypes": [], + * // "scope": {}, + * // "similaritySearchParams": {}, + * // "simpleRetrievalParams": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "retrievedMemories": [] * // } * } * @@ -133722,58 +151347,62 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Delete, + retrieve( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + retrieve( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + retrieve( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, + retrieve( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete, - callback: BodyResponseCallback + retrieve( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + retrieve( + callback: BodyResponseCallback ): void; - delete( + retrieve( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve; options = {}; } @@ -133786,29 +151415,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/memories:retrieve').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a RagFile. + * Rollback Memory to a specific revision. * @example * ```js * // Before running the sample: @@ -133837,27 +151471,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.get({ - * // Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.rollback({ + * // Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "targetRevisionId": "my_targetRevisionId" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "directUploadSource": {}, - * // "displayName": "my_displayName", - * // "fileStatus": {}, - * // "gcsSource": {}, - * // "googleDriveSource": {}, - * // "jiraSource": {}, + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "sharePointSources": {}, - * // "slackSource": {}, - * // "updateTime": "my_updateTime", - * // "userMetadata": "my_userMetadata" + * // "response": {} * // } * } * @@ -133873,58 +151508,57 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Get, + rollback( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + rollback( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + ): Promise>; + rollback( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, + rollback( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get, - callback: BodyResponseCallback + rollback( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + rollback( + callback: BodyResponseCallback ): void; - get( + rollback( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback; options = {}; } @@ -133937,8 +151571,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:rollback').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -133949,19 +151586,144 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Create extends StandardParameters { /** - * Import files from Google Cloud Storage or Google Drive into a RagCorpus. + * Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. + */ + memoryId?: string; + /** + * Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Memory; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete extends StandardParameters { + /** + * Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateMemoriesRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Get extends StandardParameters { + /** + * Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Ingestevents extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to ingest events to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1IngestEventsRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) + */ + filter?: string; + /** + * Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch extends StandardParameters { + /** + * Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + */ + name?: string; + /** + * Optional. Mask specifying which fields to update. The following fields are immutable: * `scope` * `memory_type` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Memory; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PurgeMemoriesRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve extends StandardParameters { + /** + * Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RetrieveMemoriesRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback extends StandardParameters { + /** + * Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RollbackMemoryRequest; + } + + export class Resource$Projects$Locations$Reasoningengines$Memories$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -133990,28 +151752,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.import({ - * // Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "importRagFilesConfig": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -134026,58 +151777,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions ): Promise>; - import( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, options?: MethodOptions - ): Promise>; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, + callback: BodyResponseCallback ): void; - import( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel; options = {}; } @@ -134090,32 +151837,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles:import').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists RagFiles in a RagCorpus. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -134144,21 +151888,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.ragCorpora.ragFiles.list({ - * // Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - * parent: 'projects/my-project/locations/my-location/ragCorpora/[^/]+', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.memories.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "ragFiles": [] - * // } + * // {} * } * * main().catch(e => { @@ -134173,62 +151913,54 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete; options = {}; } @@ -134241,83 +151973,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/ragFiles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Delete extends StandardParameters { - /** - * Optional. If set to true, any errors generated by external vector database during the deletion will be ignored. The default value is false. - */ - forceDelete?: boolean; - /** - * Required. The name of the RagFile resource to be deleted. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Get extends StandardParameters { - /** - * Required. The name of the RagFile resource. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}/ragFiles/{rag_file\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Import extends StandardParameters { - /** - * Required. The name of the RagCorpus resource into which to import files. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ImportRagFilesRequest; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$List extends StandardParameters { - /** - * Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used. - */ - pageSize?: number; - /** - * Optional. The standard list page token. Typically obtained via ListRagFilesResponse.next_page_token of the previous VertexRagDataService.ListRagFiles call. - */ - pageToken?: string; - /** - * Required. The resource name of the RagCorpus from which to list the RagFiles. Format: `projects/{project\}/locations/{location\}/ragCorpora/{rag_corpus\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -134347,14 +152025,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * }); + * await aiplatform.projects.locations.reasoningEngines.memories.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -134369,54 +152055,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get; options = {}; } @@ -134429,8 +152118,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -134441,17 +152130,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -134481,14 +152170,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * }); + * await aiplatform.projects.locations.reasoningEngines.memories.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 => { @@ -134503,54 +152206,62 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$Delete, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List; options = {}; } @@ -134563,8 +152274,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -134575,17 +152289,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -134615,10 +152331,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * }); + * await aiplatform.projects.locations.reasoningEngines.memories.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -134643,36 +152363,35 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, callback: BodyResponseCallback ): void; - get( + wait( callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -134688,13 +152407,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait; options = {}; } @@ -134707,8 +152426,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -134727,9 +152446,67 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Memories$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get a Memory Revision. * @example * ```js * // Before running the sample: @@ -134759,25 +152536,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * await aiplatform.projects.locations.reasoningEngines.memories.revisions.get( + * { + * // Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/revisions/my-revision', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "expireTime": "my_expireTime", + * // "extractedMemories": [], + * // "fact": "my_fact", + * // "labels": {}, + * // "name": "my_name", + * // "structuredData": {} * // } * } * @@ -134793,62 +152568,62 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get + | 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$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get; options = {}; } @@ -134861,10 +152636,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -134876,19 +152648,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * List Memory Revisions for a Memory. * @example * ```js * // Before running the sample: @@ -134918,21 +152690,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragCorpora.ragFiles.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * await aiplatform.projects.locations.reasoningEngines.memories.revisions.list( + * { + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "memoryRevisions": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -134948,58 +152724,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List; options = {}; } @@ -135012,92 +152792,59 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/revisions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` */ filter?: string; /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * Optional. 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` */ - timeout?: string; - } - - export class Resource$Projects$Locations$Ragengineconfig { - context: APIRequestContext; - operations: Resource$Projects$Locations$Ragengineconfig$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Ragengineconfig$Operations( - this.context - ); - } + parent?: string; } - export class Resource$Projects$Locations$Ragengineconfig$Operations { + export class Resource$Projects$Locations$Reasoningengines$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -135134,9 +152881,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.cancel({ + * await aiplatform.projects.locations.reasoningEngines.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * @@ -135157,31 +152904,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135197,13 +152944,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; options = {}; } @@ -135268,9 +153015,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.delete({ + * await aiplatform.projects.locations.reasoningEngines.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * @@ -135291,31 +153038,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135331,13 +153078,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; options = {}; } @@ -135402,9 +153149,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.get({ + * await aiplatform.projects.locations.reasoningEngines.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * @@ -135431,27 +153178,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -135459,7 +153205,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135475,13 +153221,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; options = {}; } @@ -135546,11 +153292,11 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.list({ + * await aiplatform.projects.locations.reasoningEngines.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/ragEngineConfig', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -135581,29 +153327,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, callback: BodyResponseCallback ): void; list( @@ -135611,7 +153357,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$List + | Params$Resource$Projects$Locations$Reasoningengines$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135629,13 +153375,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; options = {}; } @@ -135705,9 +153451,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.ragEngineConfig.operations.wait({ + * await aiplatform.projects.locations.reasoningEngines.operations.wait({ * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/ragEngineConfig/operations/my-operation', + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -135736,27 +153482,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait, + params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -135764,7 +153509,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait + | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -135780,13 +153525,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; options = {}; } @@ -135821,25 +153566,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -135861,7 +153606,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Ragengineconfig$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -135872,47 +153617,14 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines { + export class Resource$Projects$Locations$Reasoningengines$Runtimerevisions { context: APIRequestContext; - memories: Resource$Projects$Locations$Reasoningengines$Memories; - operations: Resource$Projects$Locations$Reasoningengines$Operations; - runtimeRevisions: Resource$Projects$Locations$Reasoningengines$Runtimerevisions; - sandboxEnvironments: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments; - sandboxEnvironmentSnapshots: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots; - sandboxEnvironmentTemplates: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates; - sessions: Resource$Projects$Locations$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; - this.memories = new Resource$Projects$Locations$Reasoningengines$Memories( - this.context - ); - this.operations = - new Resource$Projects$Locations$Reasoningengines$Operations( - this.context - ); - this.runtimeRevisions = - new Resource$Projects$Locations$Reasoningengines$Runtimerevisions( - this.context - ); - this.sandboxEnvironments = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments( - this.context - ); - this.sandboxEnvironmentSnapshots = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots( - this.context - ); - this.sandboxEnvironmentTemplates = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates( - this.context - ); - this.sessions = new Resource$Projects$Locations$Reasoningengines$Sessions( - this.context - ); } /** - * Async query using a reasoning engine. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -135941,28 +153653,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.asyncQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * const res = + * await aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query( + * { + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputGcsUri": "my_inputGcsUri", - * // "outputGcsUri": "my_outputGcsUri" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "output": {} * // } * } * @@ -135978,58 +153689,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - asyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, options: StreamMethodOptions ): Promise>; - asyncQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, + query( + params?: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, options?: MethodOptions - ): Promise>; - asyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - asyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - asyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Asyncquery, - callback: BodyResponseCallback + query( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, + callback: BodyResponseCallback ): void; - asyncQuery( - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - asyncQuery( + query( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Asyncquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Asyncquery; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Asyncquery; + {} as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query; options = {}; } @@ -136042,10 +153757,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:asyncQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -136057,17 +153769,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Cancels an AsyncQueryReasoningEngine operation. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -136097,22 +153811,29 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.cancelAsyncQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * await aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery( + * { + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -136127,62 +153848,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancelAsyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, options: StreamMethodOptions ): Promise>; - cancelAsyncQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + streamQuery( + params?: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - cancelAsyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, + ): Promise>; + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancelAsyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancelAsyncQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancelAsyncQuery( - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, + callback: BodyResponseCallback ): void; - cancelAsyncQuery( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery; + {} as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery; options = {}; } @@ -136195,7 +153908,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( + url: (rootUrl + '/v1/{+name}:streamQuery').replace( /([^:]\/)\/+/g, '$1' ), @@ -136210,19 +153923,52 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query extends StandardParameters { /** - * Creates a reasoning engine. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments { + context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations( + this.context + ); + } + + /** + * Creates a SandboxEnvironment in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -136251,27 +153997,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.create({ - * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create( + * { + * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", + * // "name": "my_name", + * // "owner": "my_owner", + * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", + * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -136297,27 +154050,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Create, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Create, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, callback: BodyResponseCallback ): void; create( @@ -136325,7 +154077,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Create + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136341,13 +154093,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; options = {}; } @@ -136360,7 +154112,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( /([^:]\/)\/+/g, '$1' ), @@ -136385,7 +154137,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a reasoning engine. + * Deletes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -136414,12 +154166,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.delete({ - * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - * force: 'placeholder-value', - * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete( + * { + * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * }, + * ); * console.log(res.data); * * // Example response @@ -136445,27 +154198,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, callback: BodyResponseCallback ): void; delete( @@ -136473,7 +154225,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -136489,13 +154241,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; options = {}; } @@ -136520,173 +154272,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Executes code statelessly. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.reasoningEngines.executeCode({ - * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "outputs": [] - * // } - * } - * - * 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. - */ - executeCode( - params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, - options: StreamMethodOptions - ): Promise>; - executeCode( - params?: Params$Resource$Projects$Locations$Reasoningengines$Executecode, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - executeCode( - params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - executeCode( - params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - executeCode( - params: Params$Resource$Projects$Locations$Reasoningengines$Executecode, - callback: BodyResponseCallback - ): void; - executeCode( - callback: BodyResponseCallback - ): void; - executeCode( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Executecode - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Executecode; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Executecode; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:executeCode').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a reasoning engine. + * Executes using a sandbox environment. * @example * ```js * // Before running the sample: @@ -136715,24 +154311,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.get({ - * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute( + * { + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" + * // "outputs": [] * // } * } * @@ -136748,61 +154346,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Get, + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Get, + execute( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Get, - callback: BodyResponseCallback + execute( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + execute( + callback: BodyResponseCallback ): void; - get( + execute( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute + | 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$Reasoningengines$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$Get; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; options = {}; } @@ -136815,8 +154414,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -136827,19 +154429,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Gets details of the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -136868,22 +154470,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.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/locations/my-location/reasoningEngines/my-reasoningEngine', - * }, - * ); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get( + * { + * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", + * // "name": "my_name", + * // "owner": "my_owner", + * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", + * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" * // } * } * @@ -136899,56 +154509,62 @@ export namespace aiplatform_v1 { * @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$Locations$Reasoningengines$Getiampolicy, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions ): Promise>; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options?: MethodOptions - ): Promise>; - getIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Getiampolicy; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; options = {}; } @@ -136961,32 +154577,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists reasoning engines in a location. + * Lists SandboxEnvironments in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -137015,22 +154630,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list( + * { + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // 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. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "reasoningEngines": [] + * // "sandboxEnvironments": [] * // } * } * @@ -137047,60 +154666,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$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$Reasoningengines$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Reasoningengines$List; + params = + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List; options = {}; } @@ -137113,7 +154733,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/reasoningEngines').replace( + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( /([^:]\/)\/+/g, '$1' ), @@ -137128,19 +154748,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a reasoning engine. + * Pauses the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -137169,29 +154789,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.patch({ - * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // Optional. Mask specifying which fields to update. - * updateMask: 'placeholder-value', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.pause( + * { + * // Required. The resource name of the sandbox environment to pause. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response @@ -137216,36 +154826,35 @@ export namespace aiplatform_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$Reasoningengines$Patch, + pause( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Patch, + pause( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + pause( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + pause( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Patch, + pause( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause, callback: BodyResponseCallback ): void; - patch( + pause( callback: BodyResponseCallback ): void; - patch( + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Patch + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -137261,13 +154870,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Patch; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause; options = {}; } @@ -137280,8 +154889,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -137302,7 +154911,7 @@ export namespace aiplatform_v1 { } /** - * Queries using a reasoning engine. + * Resumes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -137331,24 +154940,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.resume( + * { + * // Required. The resource name of the sandbox environment to resume. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "output": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -137364,62 +154977,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + resume( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Projects$Locations$Reasoningengines$Query, + resume( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, + resume( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Query, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - query( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Query; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Query; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume; options = {}; } @@ -137432,7 +155040,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -137444,19 +155052,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource. * @example * ```js * // Before running the sample: @@ -137485,28 +155091,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.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/locations/my-location/reasoningEngines/my-reasoningEngine', + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot( + * { + * // Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "policy": {} - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "name": "my_name", + * // "owner": "my_owner", + * // "parentSnapshot": "my_parentSnapshot", + * // "postSnapshotAction": "my_postSnapshotAction", + * // "sizeBytes": "my_sizeBytes", + * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, * }, - * }, - * ); + * ); * console.log(res.data); * * // Example response * // { - * // "bindings": [], - * // "etag": "my_etag", - * // "version": 0 + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -137522,56 +155140,57 @@ export namespace aiplatform_v1 { * @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$Locations$Reasoningengines$Setiampolicy, + snapshot( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, options: StreamMethodOptions ): Promise>; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, + snapshot( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, options?: MethodOptions - ): Promise>; - setIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, + ): Promise>; + snapshot( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + snapshot( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy, - callback: BodyResponseCallback + snapshot( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + snapshot( + callback: BodyResponseCallback ): void; - setIamPolicy( + snapshot( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Setiampolicy; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot; options = {}; } @@ -137584,7 +155203,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+name}:snapshot').replace( /([^:]\/)\/+/g, '$1' ), @@ -137594,22 +155213,115 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { /** - * Streams queries using a reasoning engine. + * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { + /** + * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { + /** + * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * 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. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Pause extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to pause. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Resume extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to resume. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSnapshot; + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -137638,27 +155350,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * } * * main().catch(e => { @@ -137673,54 +155375,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Streamquery, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Streamquery; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; options = {}; } @@ -137733,10 +155435,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -137748,17 +155447,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -137788,19 +155487,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.testIamPermissions({ - * // The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - * permissions: 'placeholder-value', - * // REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - * resource: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "permissions": [] - * // } + * // {} * } * * main().catch(e => { @@ -137815,62 +155511,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions ): Promise>; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - testIamPermissions( - params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; options = {}; } @@ -137883,198 +155571,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Asyncquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Cancelasyncquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Delete extends StandardParameters { - /** - * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - */ - force?: boolean; - /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Executecode extends StandardParameters { - /** - * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Get extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$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$Locations$Reasoningengines$List extends StandardParameters { - /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Patch extends StandardParameters { - /** - * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - /** - * Optional. Mask specifying which fields to update. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Query extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$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$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Streamquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Testiampermissions extends StandardParameters { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[]; - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Memories { - context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Memories$Operations; - revisions: Resource$Projects$Locations$Reasoningengines$Memories$Revisions; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Reasoningengines$Memories$Operations( - this.context - ); - this.revisions = - new Resource$Projects$Locations$Reasoningengines$Memories$Revisions( - this.context - ); - } /** - * Create a Memory. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -138104,35 +155623,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.create({ - * // Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. - * memoryId: 'placeholder-value', - * // Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMemoryRevisions": false, - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "fact": "my_fact", - * // "metadata": {}, - * // "name": "my_name", - * // "revisionExpireTime": "my_revisionExpireTime", - * // "revisionLabels": {}, - * // "revisionTtl": "my_revisionTtl", - * // "scope": {}, - * // "topics": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -138157,36 +155653,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Create, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Create, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Create + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138202,13 +155697,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; options = {}; } @@ -138221,18 +155716,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/memories').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -138246,7 +155738,7 @@ export namespace aiplatform_v1 { } /** - * Delete a Memory. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -138276,10 +155768,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.delete({ - * // Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -138304,36 +155800,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Delete, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138349,13 +155844,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; options = {}; } @@ -138368,8 +155863,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -138388,9 +155883,50 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { /** - * Generate memories. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots { + context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations( + this.context + ); + } + + /** + * Deletes the specific SandboxEnvironmentSnapshot. * @example * ```js * // Before running the sample: @@ -138420,30 +155956,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.generate({ - * // Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "allowedTopics": [], - * // "directContentsSource": {}, - * // "directMemoriesSource": {}, - * // "disableConsolidation": false, - * // "disableMemoryRevisions": false, - * // "metadata": {}, - * // "metadataMergeStrategy": "my_metadataMergeStrategy", - * // "revisionExpireTime": "my_revisionExpireTime", - * // "revisionLabels": {}, - * // "revisionTtl": "my_revisionTtl", - * // "scope": {}, - * // "vertexSessionSource": {} - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete( + * { + * // Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -138468,36 +155986,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generate( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: StreamMethodOptions ): Promise>; - generate( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options?: MethodOptions ): Promise>; - generate( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generate( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generate( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, callback: BodyResponseCallback ): void; - generate( + delete( callback: BodyResponseCallback ): void; - generate( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -138513,13 +156030,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete; options = {}; } @@ -138532,18 +156049,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/memories:generate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -138557,7 +156071,7 @@ export namespace aiplatform_v1 { } /** - * Get a Memory. + * Gets details of the specific SandboxEnvironmentSnapshot. * @example * ```js * // Before running the sample: @@ -138586,29 +156100,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.memories.get( - * { - * // Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', - * }, - * ); + * const res = + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get( + * { + * // Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', + * }, + * ); * console.log(res.data); * * // Example response * // { * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMemoryRevisions": false, * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", - * // "fact": "my_fact", - * // "metadata": {}, * // "name": "my_name", - * // "revisionExpireTime": "my_revisionExpireTime", - * // "revisionLabels": {}, - * // "revisionTtl": "my_revisionTtl", - * // "scope": {}, - * // "topics": [], + * // "owner": "my_owner", + * // "parentSnapshot": "my_parentSnapshot", + * // "postSnapshotAction": "my_postSnapshotAction", + * // "sizeBytes": "my_sizeBytes", + * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", * // "ttl": "my_ttl", * // "updateTime": "my_updateTime" * // } @@ -138627,57 +156138,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get; options = {}; } @@ -138702,19 +156217,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List Memories. + * Lists SandboxEnvironmentSnapshots in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -138744,25 +156259,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) - * filter: 'placeholder-value', - * // Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` - * orderBy: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list( + * { + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "memories": [], - * // "nextPageToken": "my_nextPageToken" + * // "nextPageToken": "my_nextPageToken", + * // "sandboxEnvironmentSnapshots": [] * // } * } * @@ -138779,61 +156294,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$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$Reasoningengines$Memories$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List; options = {}; } @@ -138846,10 +156361,9 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/memories').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/sandboxEnvironmentSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -138861,19 +156375,57 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete extends StandardParameters { /** - * Update a Memory. + * Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get extends StandardParameters { + /** + * Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -138903,44 +156455,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.patch({ - * // Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', - * // Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact` - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "disableMemoryRevisions": false, - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "fact": "my_fact", - * // "metadata": {}, - * // "name": "my_name", - * // "revisionExpireTime": "my_revisionExpireTime", - * // "revisionLabels": {}, - * // "revisionTtl": "my_revisionTtl", - * // "scope": {}, - * // "topics": [], - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -138955,58 +156479,54 @@ export namespace aiplatform_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$Reasoningengines$Memories$Patch, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + callback: BodyResponseCallback ): void; - patch( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; options = {}; } @@ -139019,8 +156539,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -139031,17 +156551,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Purge memories. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -139071,31 +156591,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.purge({ - * // Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "filterGroups": [], - * // "force": false - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -139110,58 +156615,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options: StreamMethodOptions ): Promise>; - purge( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options?: MethodOptions - ): Promise>; - purge( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + callback: BodyResponseCallback ): void; - purge( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; options = {}; } @@ -139174,32 +156675,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/memories:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieve memories. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -139229,30 +156727,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.retrieve({ - * // Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "filterGroups": [], - * // "memoryTypes": [], - * // "scope": {}, - * // "similaritySearchParams": {}, - * // "simpleRetrievalParams": {} - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "retrievedMemories": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -139268,62 +156757,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - retrieve( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options: StreamMethodOptions ): Promise>; - retrieve( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - retrieve( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - retrieve( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - retrieve( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + callback: BodyResponseCallback ): void; - retrieve( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - retrieve( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; options = {}; } @@ -139336,34 +156820,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/memories:retrieve').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Rollback Memory to a specific revision. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -139393,18 +156872,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.rollback({ - * // Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "targetRevisionId": "my_targetRevisionId" - * // } + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -139429,36 +156904,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rollback( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: StreamMethodOptions ): Promise>; - rollback( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options?: MethodOptions ): Promise>; - rollback( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rollback( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rollback( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, callback: BodyResponseCallback ): void; - rollback( + wait( callback: BodyResponseCallback ): void; - rollback( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -139474,13 +156948,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; options = {}; } @@ -139493,10 +156967,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:rollback').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -139518,123 +156989,48 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Create extends StandardParameters { - /** - * Optional. The user defined ID to use for memory, which will become the final component of the memory resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. - */ - memoryId?: string; - /** - * Required. The resource name of the ReasoningEngine to create the Memory under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Memory; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the Memory to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Generate extends StandardParameters { - /** - * Required. The resource name of the ReasoningEngine to generate memories for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateMemoriesRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$List extends StandardParameters { - /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields: * `scope` (as a JSON string with equality match only) * `topics` (i.e. `topics.custom_memory_topic_label: "example topic" OR topics.managed_memory_topic: USER_PREFERENCES`) - */ - filter?: string; - /** - * Optional. The standard list order by string. If not specified, the default order is `create_time desc`. If specified, the default sorting order of provided fields is ascending. More detail in [AIP-132](https://google.aip.dev/132). Supported fields: * `create_time` * `update_time` - */ - orderBy?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the ReasoningEngine to list the Memories under. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get extends StandardParameters { /** - * Identifier. Represents the resource name of the Memory. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * The name of the operation resource. */ name?: string; - /** - * Optional. Mask specifying which fields to update. Supported fields: * `display_name` * `description` * `fact` - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Memory; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Purge extends StandardParameters { - /** - * Required. The resource name of the ReasoningEngine to purge memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PurgeMemoriesRequest; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Retrieve extends StandardParameters { - /** - * Required. The resource name of the ReasoningEngine to retrieve memories from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1RetrieveMemoriesRequest; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Rollback extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the Memory to rollback. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1RollbackMemoryRequest; + timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Memories$Operations { + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates { context: APIRequestContext; + operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a SandboxEnvironmentTemplate in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -139664,16 +157060,38 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.operations.cancel( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create( * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "customContainerEnvironment": {}, + * // "defaultContainerEnvironment": {}, + * // "displayName": "my_displayName", + * // "egressControlConfig": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -139688,54 +157106,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create; options = {}; } @@ -139748,29 +157169,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes the specific SandboxEnvironmentTemplate. * @example * ```js * // Before running the sample: @@ -139800,16 +157223,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.operations.delete( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete( * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -139825,53 +157254,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete; options = {}; } @@ -139896,17 +157328,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets details of the specific SandboxEnvironmentTemplate. * @example * ```js * // Before running the sample: @@ -139936,21 +157368,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.operations.get( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "customContainerEnvironment": {}, + * // "defaultContainerEnvironment": {}, + * // "displayName": "my_displayName", + * // "egressControlConfig": {}, * // "name": "my_name", - * // "response": {} + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -139967,57 +157402,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get; options = {}; } @@ -140042,17 +157481,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists SandboxEnvironmentTemplates in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -140082,27 +157523,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.operations.list( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list( * { - * // The standard list filter. + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', - * // The standard list page size. + * // Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "nextPageToken": "my_nextPageToken", + * // "sandboxEnvironmentTemplates": [] * // } * } * @@ -140119,61 +157558,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$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$Reasoningengines$Memories$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List; options = {}; } @@ -140186,34 +157625,82 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, 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$Reasoningengines$Sandboxenvironmenttemplates$Create extends StandardParameters { /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplate; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete extends StandardParameters { + /** + * Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get extends StandardParameters { + /** + * Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -140243,24 +157730,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.operations.wait( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel( * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -140275,58 +157754,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + callback: BodyResponseCallback ): void; - wait( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; options = {}; } @@ -140339,7 +157814,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -140351,75 +157826,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Memories$Revisions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Get a Memory Revision. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -140449,24 +157866,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.revisions.get( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete( * { - * // Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie/revisions/my-revision', + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "expireTime": "my_expireTime", - * // "extractedMemories": [], - * // "fact": "my_fact", - * // "labels": {}, - * // "name": "my_name", - * // "structuredData": {} - * // } + * // {} * } * * main().catch(e => { @@ -140481,62 +157890,54 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Revisions$Get, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; options = {}; } @@ -140550,7 +157951,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -140561,19 +157962,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * List Memory Revisions for a Memory. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -140603,25 +158002,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.memories.revisions.list( + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get( * { - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/memories/my-memorie', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "memoryRevisions": [], - * // "nextPageToken": "my_nextPageToken" + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -140637,62 +158032,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Revisions$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; options = {}; } @@ -140705,66 +158095,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/revisions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$Get extends StandardParameters { - /** - * Required. The resource name of the Memory Revision to retrieve. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}/revisions/{revision\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Memories$Revisions$List extends StandardParameters { - /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). Supported fields (equality match only): * `labels` - */ - filter?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; - /** - * Optional. The standard list page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Memory to list revisions for. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/memories/{memory\}` - */ - parent?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -140794,14 +158147,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * }); + * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -140816,54 +158179,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; options = {}; } @@ -140876,7 +158242,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -140888,17 +158254,63 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel extends StandardParameters { /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Sessions { + context: APIRequestContext; + events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; + operations: Resource$Projects$Locations$Reasoningengines$Sessions$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.events = + new Resource$Projects$Locations$Reasoningengines$Sessions$Events( + this.context + ); + this.operations = + new Resource$Projects$Locations$Reasoningengines$Sessions$Operations( + this.context + ); + } + + /** + * Appends an event to a given session. * @example * ```js * // Before running the sample: @@ -140928,9 +158340,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * await aiplatform.projects.locations.reasoningEngines.sessions.appendEvent({ + * // Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "actions": {}, + * // "author": "my_author", + * // "content": {}, + * // "errorCode": "my_errorCode", + * // "errorMessage": "my_errorMessage", + * // "eventMetadata": {}, + * // "invocationId": "my_invocationId", + * // "name": "my_name", + * // "rawEvent": {}, + * // "timestamp": "my_timestamp" + * // } + * }, * }); * console.log(res.data); * @@ -140950,54 +158379,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$Delete, + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + appendEvent( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete, - callback: BodyResponseCallback + appendEvent( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + appendEvent( + callback: BodyResponseCallback + ): void; + appendEvent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; options = {}; } @@ -141010,8 +158447,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:appendEvent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -141022,17 +158462,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Creates a new Session. * @example * ```js * // Before running the sample: @@ -141062,9 +158504,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', + * await aiplatform.projects.locations.reasoningEngines.sessions.create({ + * // Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. + * sessionId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" + * // } + * }, * }); * console.log(res.data); * @@ -141090,36 +158551,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Get + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -141135,13 +158595,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; options = {}; } @@ -141154,15 +158614,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -141176,7 +158639,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes details of the specific Session. * @example * ```js * // Before running the sample: @@ -141206,25 +158669,19 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * await aiplatform.projects.locations.reasoningEngines.sessions.delete({ + * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -141240,62 +158697,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; options = {}; } @@ -141308,11 +158760,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -141323,19 +158772,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Gets details of the specific Session. * @example * ```js * // Before running the sample: @@ -141364,22 +158811,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.reasoningEngines.sessions.get( + * { + * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" * // } * } * @@ -141395,58 +158845,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + get( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - wait( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; options = {}; } @@ -141459,8 +158909,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -141471,75 +158921,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Runtimerevisions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Queries using a reasoning engine. + * Lists Sessions in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -141569,26 +158963,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.runtimeRevisions.query( - * { - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.reasoningEngines.sessions.list({ + * // Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. + * filter: 'placeholder-value', + * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. + * orderBy: 'placeholder-value', + * // Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { - * // "output": {} + * // "nextPageToken": "my_nextPageToken", + * // "sessions": [] * // } * } * @@ -141604,62 +158997,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - query( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$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$Reasoningengines$Runtimerevisions$Query; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; options = {}; } @@ -141672,31 +159065,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, 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 ); } } /** - * Streams queries using a reasoning engine. + * Updates the specific Session. * @example * ```js * // Before running the sample: @@ -141726,28 +159122,41 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.runtimeRevisions.streamQuery( - * { - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', + * await aiplatform.projects.locations.reasoningEngines.sessions.patch({ + * // Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * // Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "labels": {}, + * // "name": "my_name", + * // "sessionState": {}, + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime", + * // "userId": "my_userId" * // } * } * @@ -141763,54 +159172,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, + patch( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; options = {}; } @@ -141823,11 +159236,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -141838,52 +159248,102 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Query extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + requestBody?: Schema$GoogleCloudAiplatformV1SessionEvent; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Runtimerevisions$Streamquery extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + /** + * Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. + */ + sessionId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Session; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete extends StandardParameters { + /** + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get extends StandardParameters { + /** + * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$List extends StandardParameters { + /** + * Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. + */ + orderBy?: string; + /** + * Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. + */ + pageToken?: string; + /** + * Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch extends StandardParameters { + /** + * Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. */ name?: string; + /** + * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Session; } - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments { + export class Resource$Projects$Locations$Reasoningengines$Sessions$Events { context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations( - this.context - ); } /** - * Creates a SandboxEnvironment in a given reasoning engine. + * Lists Events in a given session. * @example * ```js * // Before running the sample: @@ -141913,42 +159373,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.create( - * { - * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "connectionInfo": {}, - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", - * // "name": "my_name", - * // "owner": "my_owner", - * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", - * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", - * // "spec": {}, - * // "state": "my_state", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } - * }, - * }, - * ); + * await aiplatform.projects.locations.reasoningEngines.sessions.events.list({ + * // Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // 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`. + * orderBy: 'placeholder-value', + * // 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. + * pageSize: 'placeholder-value', + * // Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * parent: + * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "sessionEvents": [] * // } * } * @@ -141964,58 +159407,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Create, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, + list( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; options = {}; } @@ -142028,11 +159475,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + url: (rootUrl + '/v1/{+parent}/events').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -142043,17 +159490,49 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List extends StandardParameters { /** - * Deletes the specific SandboxEnvironment. + * Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + */ + pageToken?: string; + /** + * Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Reasoningengines$Sessions$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -142083,22 +159562,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.delete( + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel( * { - * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -142113,58 +159586,54 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Delete, + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; options = {}; } @@ -142177,8 +159646,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -142189,17 +159658,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Executes using a sandbox environment. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -142229,26 +159698,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.execute( + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.delete( * { - * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [] - * // } - * }, + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "outputs": [] - * // } + * // {} * } * * main().catch(e => { @@ -142263,62 +159722,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - execute( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options: StreamMethodOptions ): Promise>; - execute( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, + delete( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - execute( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - execute( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - execute( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - execute( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + callback: BodyResponseCallback ): void; - execute( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; options = {}; } @@ -142331,11 +159782,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:execute').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -142346,19 +159794,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets details of the specific SandboxEnvironment. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -142388,29 +159834,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.get( + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.get( * { - * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "connectionInfo": {}, - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "owner": "my_owner", - * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", - * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", - * // "spec": {}, - * // "state": "my_state", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -142427,61 +159865,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; options = {}; } @@ -142506,19 +159939,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists SandboxEnvironments in a given reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -142548,17 +159979,18 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.list( + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.list( * { - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * // The standard list filter. * filter: 'placeholder-value', - * // 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. + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * // The standard list page size. * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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); @@ -142566,7 +159998,8 @@ export namespace aiplatform_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironments": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -142583,61 +160016,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$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$Reasoningengines$Sandboxenvironments$List; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; options = {}; } @@ -142650,7 +160083,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -142660,24 +160093,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -142707,28 +160140,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.snapshot( + * await aiplatform.projects.locations.reasoningEngines.sessions.operations.wait( * { - * // Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "name": "my_name", - * // "owner": "my_owner", - * // "parentSnapshot": "my_parentSnapshot", - * // "postSnapshotAction": "my_postSnapshotAction", - * // "sizeBytes": "my_sizeBytes", - * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } - * }, + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, * ); * console.log(res.data); @@ -142755,36 +160172,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - snapshot( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions ): Promise>; - snapshot( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + wait( + params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options?: MethodOptions ): Promise>; - snapshot( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - snapshot( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - snapshot( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot, + wait( + params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, callback: BodyResponseCallback ): void; - snapshot( + wait( callback: BodyResponseCallback ): void; - snapshot( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot + | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -142800,13 +160216,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot; + {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot; + {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; options = {}; } @@ -142819,10 +160235,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:snapshot').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -142844,78 +160257,69 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { - /** - * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { /** - * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * The name of the operation resource to be deleted. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get extends StandardParameters { /** - * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * 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. + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Snapshot extends StandardParameters { + export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSnapshot; + timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations { + export class Resource$Projects$Locations$Schedules { context: APIRequestContext; + operations: Resource$Projects$Locations$Schedules$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = new Resource$Projects$Locations$Schedules$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a Schedule. * @example * ```js * // Before running the sample: @@ -142944,17 +160348,62 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.create({ + * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -142969,54 +160418,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Schedules$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Schedules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schedules$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Schedules$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Schedules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Schedules$Create; options = {}; } @@ -143029,29 +160481,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/schedules').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Schedule. * @example * ```js * // Before running the sample: @@ -143080,17 +160537,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.delete({ + * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -143106,53 +160566,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + params?: Params$Resource$Projects$Locations$Schedules$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Schedules$Delete; options = {}; } @@ -143177,17 +160639,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Schedule. * @example * ```js * // Before running the sample: @@ -143216,22 +160678,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.get({ + * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -143248,57 +160722,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + params?: Params$Resource$Projects$Locations$Schedules$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Schedules$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Schedules$Get; options = {}; } @@ -143323,17 +160796,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists Schedules in a Location. * @example * ```js * // Before running the sample: @@ -143362,24 +160837,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironments.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.list({ + * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` + * filter: 'placeholder-value', + * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * orderBy: 'placeholder-value', + * // The standard list page size. Default to 100 if not specified. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "schedules": [] * // } * } * @@ -143395,58 +160870,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Schedules$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Schedules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Schedules$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Schedules$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Schedules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Schedules$List; options = {}; } @@ -143459,70 +160937,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/schedules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots { - context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Deletes the specific SandboxEnvironmentSnapshot. + * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. * @example * ```js * // Before running the sample: @@ -143551,22 +160993,63 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.delete( - * { - * // Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.patch({ + * // Immutable. The resource name of the Schedule. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", + * // "name": "my_name", + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "allowQueueing": false, + * // "catchUp": false, + * // "createNotebookExecutionJobRequest": {}, + * // "createPipelineJobRequest": {}, + * // "createTime": "my_createTime", + * // "cron": "my_cron", + * // "displayName": "my_displayName", + * // "endTime": "my_endTime", + * // "lastPauseTime": "my_lastPauseTime", + * // "lastResumeTime": "my_lastResumeTime", + * // "lastScheduledRunResponse": {}, + * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", + * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", + * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "response": {} + * // "nextRunTime": "my_nextRunTime", + * // "startTime": "my_startTime", + * // "startedRunCount": "my_startedRunCount", + * // "state": "my_state", + * // "updateTime": "my_updateTime" * // } * } * @@ -143582,58 +161065,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + patch( + params?: Params$Resource$Projects$Locations$Schedules$Patch, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Schedules$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete; + params = {} as Params$Resource$Projects$Locations$Schedules$Patch; options = {}; } @@ -143647,7 +161129,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -143658,17 +161140,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of the specific SandboxEnvironmentSnapshot. + * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. * @example * ```js * // Before running the sample: @@ -143697,29 +161181,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.get( - * { - * // Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.pause({ + * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "name": "my_name", - * // "owner": "my_owner", - * // "parentSnapshot": "my_parentSnapshot", - * // "postSnapshotAction": "my_postSnapshotAction", - * // "sizeBytes": "my_sizeBytes", - * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -143734,62 +161209,53 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmentsnapshots$Get, + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, + pause( + params?: Params$Resource$Projects$Locations$Schedules$Pause, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, + ): Promise>; + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Schedules$Pause, + callback: BodyResponseCallback ): void; - get( + pause(callback: BodyResponseCallback): void; + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get; + params = {} as Params$Resource$Projects$Locations$Schedules$Pause; options = {}; } @@ -143802,8 +161268,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -143814,19 +161280,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists SandboxEnvironmentSnapshots in a given reasoning engine. + * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. * @example * ```js * // Before running the sample: @@ -143855,27 +161319,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.list( - * { - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.resume({ + * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "catchUp": false + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironmentSnapshots": [] - * // } + * // {} * } * * main().catch(e => { @@ -143890,62 +161349,53 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmentsnapshots$List, + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, + resume( + params?: Params$Resource$Projects$Locations$Schedules$Resume, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, + ): Promise>; + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Schedules$Resume, + callback: BodyResponseCallback ): void; - list( + resume(callback: BodyResponseCallback): void; + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Schedules$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List; + {}) as Params$Resource$Projects$Locations$Schedules$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List; + params = {} as Params$Resource$Projects$Locations$Schedules$Resume; options = {}; } @@ -143958,64 +161408,112 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentSnapshots' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Create extends StandardParameters { /** - * Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + } + export interface Params$Resource$Projects$Locations$Schedules$Delete extends StandardParameters { + /** + * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Get extends StandardParameters { /** - * Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` */ filter?: string; /** - * Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + */ + orderBy?: string; + /** + * The standard list page size. Default to 100 if not specified. */ pageSize?: number; /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. */ pageToken?: string; /** - * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; } + export interface Params$Resource$Projects$Locations$Schedules$Patch extends StandardParameters { + /** + * Immutable. The resource name of the Schedule. + */ + name?: string; + /** + * Required. The update mask applies to the resource. See google.protobuf.FieldMask. + */ + updateMask?: string; - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + } + export interface Params$Resource$Projects$Locations$Schedules$Pause extends StandardParameters { + /** + * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; + } + export interface Params$Resource$Projects$Locations$Schedules$Resume extends StandardParameters { + /** + * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; + } + + export class Resource$Projects$Locations$Schedules$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -144051,13 +161549,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144077,31 +161572,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel + | Params$Resource$Projects$Locations$Schedules$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144117,13 +161612,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; options = {}; } @@ -144187,13 +161682,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144213,31 +161705,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete + | Params$Resource$Projects$Locations$Schedules$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144253,13 +161745,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; options = {}; } @@ -144323,13 +161815,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -144355,27 +161844,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Projects$Locations$Schedules$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -144383,7 +161871,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get + | Params$Resource$Projects$Locations$Schedules$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144399,13 +161887,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; options = {}; } @@ -144439,6 +161927,164 @@ export namespace aiplatform_v1 { } } + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.schedules.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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$Schedules$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Schedules$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Schedules$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Schedules$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Schedules$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + /** * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example @@ -144469,15 +162115,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.schedules.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -144503,27 +162146,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -144531,7 +162173,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait + | Params$Resource$Projects$Locations$Schedules$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144547,13 +162189,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; + {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; options = {}; } @@ -144588,25 +162230,47 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Schedules$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -144617,19 +162281,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates { + export class Resource$Projects$Locations$Semanticgovernancepolicies { context: APIRequestContext; - operations: Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations; + operations: Resource$Projects$Locations$Semanticgovernancepolicies$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations( + new Resource$Projects$Locations$Semanticgovernancepolicies$Operations( this.context ); } /** - * Creates a SandboxEnvironmentTemplate in a given reasoning engine. + * Creates a SemanticGovernancePolicy. * @example * ```js * // Before running the sample: @@ -144659,28 +162323,29 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.create( - * { - * // Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * await aiplatform.projects.locations.semanticGovernancePolicies.create({ + * // Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number. + * semanticGovernancePolicyId: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "customContainerEnvironment": {}, - * // "defaultContainerEnvironment": {}, - * // "displayName": "my_displayName", - * // "egressControlConfig": {}, - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agent": "my_agent", + * // "agentIdentity": "my_agentIdentity", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "mcpTools": [], + * // "name": "my_name", + * // "naturalLanguageConstraint": "my_naturalLanguageConstraint", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response @@ -144706,27 +162371,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create, options?: MethodOptions ): Promise>; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create, callback: BodyResponseCallback ): void; create( @@ -144734,7 +162398,7 @@ export namespace aiplatform_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -144750,13 +162414,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create; options = {}; } @@ -144769,9 +162433,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/semanticGovernancePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -144793,7 +162458,7 @@ export namespace aiplatform_v1 { } /** - * Deletes the specific SandboxEnvironmentTemplate. + * Deletes a SemanticGovernancePolicy. * @example * ```js * // Before running the sample: @@ -144823,21 +162488,169 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.delete( - * { - * // Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', - * }, - * ); + * await aiplatform.projects.locations.semanticGovernancePolicies.delete({ + * // Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned. + * etag: 'placeholder-value', + * // Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project\}/locations/{location\}/semanticGovernancePolicies/{semantic_governance_policy\}` + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie', + * }); + * 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$Semanticgovernancepolicies$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 a SemanticGovernancePolicy. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.semanticGovernancePolicies.get({ + * // Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project\}/locations/{location\}/semanticGovernancePolicies/{semantic_governance_policy\}` + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "agent": "my_agent", + * // "agentIdentity": "my_agentIdentity", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "mcpTools": [], * // "name": "my_name", - * // "response": {} + * // "naturalLanguageConstraint": "my_naturalLanguageConstraint", + * // "updateTime": "my_updateTime" * // } * } * @@ -144853,58 +162666,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get; options = {}; } @@ -144918,7 +162735,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -144929,17 +162746,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of the specific SandboxEnvironmentTemplate. + * Lists SemanticGovernancePolicies in a given location. * @example * ```js * // Before running the sample: @@ -144969,24 +162788,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.get( - * { - * // Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', - * }, - * ); + * await aiplatform.projects.locations.semanticGovernancePolicies.list({ + * // Optional. The list page size. If zero, a default page size of 10 is used. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "customContainerEnvironment": {}, - * // "defaultContainerEnvironment": {}, - * // "displayName": "my_displayName", - * // "egressControlConfig": {}, - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "semanticGovernancePolicies": [] * // } * } * @@ -145002,62 +162817,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$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$Reasoningengines$Sandboxenvironmenttemplates$Get; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$List; options = {}; } @@ -145070,31 +162885,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/semanticGovernancePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, 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 ); } } /** - * Lists SandboxEnvironmentTemplates in a given reasoning engine. + * Updates a SemanticGovernancePolicy. * @example * ```js * // Before running the sample: @@ -145124,25 +162942,38 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.list( - * { - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * await aiplatform.projects.locations.semanticGovernancePolicies.patch({ + * // Identifier. Resource name of the SemanticGovernancePolicy. + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie', + * // Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "agent": "my_agent", + * // "agentIdentity": "my_agentIdentity", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "mcpTools": [], + * // "name": "my_name", + * // "naturalLanguageConstraint": "my_naturalLanguageConstraint", + * // "updateTime": "my_updateTime" + * // } * }, - * ); + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironmentTemplates": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -145158,62 +162989,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$List, + patch( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, + patch( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, + patch( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch; options = {}; } @@ -145226,75 +163052,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Create extends StandardParameters { /** - * Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * Required. The resource name of the Location into which to create the SemanticGovernancePolicy. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + /** + * Required. The ID to use for the SemanticGovernancePolicy, which will become the final component of the SemanticGovernancePolicy's resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character cannot be a number or hyphen. The last character must be a letter or a number. + */ + semanticGovernancePolicyId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplate; + requestBody?: Schema$GoogleCloudAiplatformV1SemanticGovernancePolicy; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Delete extends StandardParameters { /** - * Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * Optional. The etag of the SemanticGovernancePolicy. If an etag is provided and does not match the current etag of the SemanticGovernancePolicy, deletion will be blocked and an ABORTED error will be returned. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Get extends StandardParameters { + etag?: string; /** - * Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * Required. The name of the SemanticGovernancePolicy resource to be deleted. Format: `projects/{project\}/locations/{location\}/semanticGovernancePolicies/{semantic_governance_policy\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Get extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * Required. The name of the SemanticGovernancePolicy resource. Format: `projects/{project\}/locations/{location\}/semanticGovernancePolicies/{semantic_governance_policy\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$List extends StandardParameters { /** - * Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. + * Optional. The list page size. If zero, a default page size of 10 is used. */ pageSize?: number; /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. + * Optional. The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the Location from which to list the SemanticGovernancePolicies. Format: `projects/{project\}/locations/{location\}` */ parent?: string; } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Patch extends StandardParameters { + /** + * Identifier. Resource name of the SemanticGovernancePolicy. + */ + name?: string; + /** + * Optional. `update_mask` is used to specify the fields to be overwritten in the SemanticGovernancePolicy resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the mask is not present, then all fields that are populated in the request message will be overwritten. Set the `update_mask` to `*` to override all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SemanticGovernancePolicy; + } - export class Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations { + export class Resource$Projects$Locations$Semanticgovernancepolicies$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -145331,10 +163172,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel( + * await aiplatform.projects.locations.semanticGovernancePolicies.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }, * ); * console.log(res.data); @@ -145356,31 +163197,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145396,13 +163237,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel; options = {}; } @@ -145467,10 +163308,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.delete( + * await aiplatform.projects.locations.semanticGovernancePolicies.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }, * ); * console.log(res.data); @@ -145492,31 +163333,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145532,13 +163373,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete; options = {}; } @@ -145603,10 +163444,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.get( + * await aiplatform.projects.locations.semanticGovernancePolicies.operations.get( * { * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }, * ); * console.log(res.data); @@ -145634,27 +163475,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -145662,7 +163502,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -145678,13 +163518,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get; options = {}; } @@ -145719,7 +163559,7 @@ export namespace aiplatform_v1 { } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -145749,23 +163589,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.operations.wait( + * await aiplatform.projects.locations.semanticGovernancePolicies.operations.list( * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -145781,58 +163625,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$List; options = {}; } @@ -145845,8 +163693,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -145857,63 +163708,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Reasoningengines$Sessions { - context: APIRequestContext; - events: Resource$Projects$Locations$Reasoningengines$Sessions$Events; - operations: Resource$Projects$Locations$Reasoningengines$Sessions$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.events = - new Resource$Projects$Locations$Reasoningengines$Sessions$Events( - this.context - ); - this.operations = - new Resource$Projects$Locations$Reasoningengines$Sessions$Operations( - this.context + return createAPIRequest( + parameters ); + } } /** - * Appends an event to a given session. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -145943,31 +163750,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.appendEvent({ - * // Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "actions": {}, - * // "author": "my_author", - * // "content": {}, - * // "errorCode": "my_errorCode", - * // "errorMessage": "my_errorMessage", - * // "eventMetadata": {}, - * // "invocationId": "my_invocationId", - * // "name": "my_name", - * // "rawEvent": {}, - * // "timestamp": "my_timestamp" - * // } + * await aiplatform.projects.locations.semanticGovernancePolicies.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -145982,62 +163782,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + wait( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait, options: StreamMethodOptions ): Promise>; - appendEvent( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + wait( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, + wait( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - appendEvent( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait, + callback: BodyResponseCallback ): void; - appendEvent( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - appendEvent( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent - | BodyResponseCallback + | Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Appendevent; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait; options = {}; } @@ -146050,10 +163845,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:appendEvent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -146065,19 +163857,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Cancel extends StandardParameters { /** - * Creates a new Session. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicies$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Semanticgovernancepolicyengine { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deprovisions the SemanticGovernancePolicyEngine, tearing down the associated tenant project, GKE cluster, and PSC service attachments. This operation is irreversible. Returns a long-running operation; poll for completion. The response contains the SemanticGovernancePolicyEngine in DEPROVISIONING state. * @example * ```js * // Before running the sample: @@ -146107,29 +163955,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.create({ - * // Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', - * // Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. - * sessionId: 'placeholder-value', + * await aiplatform.projects.locations.semanticGovernancePolicyEngine.deprovision( + * { + * // Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + * name: 'projects/my-project/locations/my-location/semanticGovernancePolicyEngine', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "force": false + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -146154,36 +163993,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sessions$Create, + deprovision( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + deprovision( + params?: Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + deprovision( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + deprovision( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create, + deprovision( + params: Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision, callback: BodyResponseCallback ): void; - create( + deprovision( callback: BodyResponseCallback ): void; - create( + deprovision( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create + | Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -146199,13 +164037,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision; options = {}; } @@ -146218,7 +164056,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+name}:deprovision').replace( /([^:]\/)\/+/g, '$1' ), @@ -146228,8 +164066,8 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -146241,9 +164079,40 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Semanticgovernancepolicyengine$Deprovision extends StandardParameters { /** - * Deletes details of the specific Session. + * Required. The resource name of the SemanticGovernancePolicyEngine to deprovision. Format: projects/{project\}/locations/{location\}/semanticGovernancePolicyEngine + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeprovisionSemanticGovernancePolicyEngineRequest; + } + + export class Resource$Projects$Locations$Servingprofiles { + context: APIRequestContext; + operations: Resource$Projects$Locations$Servingprofiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Servingprofiles$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Servingprofiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -146273,20 +164142,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.delete({ - * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * await aiplatform.projects.locations.servingProfiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/servingProfiles/my-servingProfile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -146301,58 +164164,54 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sessions$Delete, + cancel( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + cancel( + params?: Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel, + callback: BodyResponseCallback ): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel; options = {}; } @@ -146365,8 +164224,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -146377,17 +164236,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of the specific Session. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -146416,26 +164275,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.reasoningEngines.sessions.get( - * { - * // Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * }, - * ); + * const res = + * await aiplatform.projects.locations.servingProfiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/servingProfiles/my-servingProfile/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } + * // {} * } * * main().catch(e => { @@ -146450,58 +164298,54 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sessions$Get, + delete( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + delete( + params?: Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete; options = {}; } @@ -146515,7 +164359,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -146526,19 +164370,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Sessions in a given reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -146568,25 +164410,19 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.list({ - * // Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. - * filter: 'placeholder-value', - * // Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. - * orderBy: 'placeholder-value', - * // Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100. - * pageSize: 'placeholder-value', - * // Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine', + * await aiplatform.projects.locations.servingProfiles.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/servingProfiles/my-servingProfile/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sessions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -146602,62 +164438,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sessions$List, + get( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + get( + params?: Params$Resource$Projects$Locations$Servingprofiles$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, + get( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servingprofiles$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Servingprofiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$List; + {} as Params$Resource$Projects$Locations$Servingprofiles$Operations$Get; options = {}; } @@ -146670,34 +164501,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the specific Session. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -146727,41 +164553,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.patch({ - * // Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * // Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" - * // } - * }, + * await aiplatform.projects.locations.servingProfiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/servingProfiles/my-servingProfile', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "labels": {}, - * // "name": "my_name", - * // "sessionState": {}, - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime", - * // "userId": "my_userId" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -146777,58 +164587,62 @@ export namespace aiplatform_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$Reasoningengines$Sessions$Patch, + list( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$List, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + list( + params?: Params$Resource$Projects$Locations$Servingprofiles$Operations$List, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, + list( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servingprofiles$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Servingprofiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Servingprofiles$Operations$List; options = {}; } @@ -146841,114 +164655,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + 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$Reasoningengines$Sessions$Appendevent extends StandardParameters { - /** - * Required. The resource name of the session to append event to. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SessionEvent; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Create extends StandardParameters { - /** - * Required. The resource name of the location to create the session in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - /** - * Optional. The user defined ID to use for session, which will become the final component of the session resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. - */ - sessionId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Session; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Delete extends StandardParameters { - /** - * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Get extends StandardParameters { - /** - * Required. The resource name of the session. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$List extends StandardParameters { - /** - * Optional. The standard list filter. Supported fields: * `display_name` * `user_id` * `labels` Example: `display_name="abc"`, `user_id="123"`, `labels.key="value"`. - */ - filter?: string; - /** - * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`. - */ - orderBy?: string; - /** - * Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, the default page size is 100. Values greater than 100 will be capped at 100. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous list SessionService.ListSessions call. - */ - pageToken?: string; - /** - * Required. The resource name of the location to list sessions from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Patch extends StandardParameters { - /** - * Identifier. The resource name of the session. Format: 'projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}'. - */ - name?: string; - /** - * Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Session; - } - - export class Resource$Projects$Locations$Reasoningengines$Sessions$Events { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Lists Events in a given session. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -146978,25 +164712,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.events.list({ - * // Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // 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`. - * orderBy: 'placeholder-value', - * // 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. - * pageSize: 'placeholder-value', - * // Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` - * parent: - * 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', + * await aiplatform.projects.locations.servingProfiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/servingProfiles/my-servingProfile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sessionEvents": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -147012,62 +164742,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sessions$Events$List, + wait( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + wait( + params?: Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, + wait( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; + {}) as Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List; + {} as Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait; options = {}; } @@ -147080,57 +164805,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/events').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Events$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Servingprofiles$Operations$Cancel extends StandardParameters { /** - * Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. `timestamp\>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 format) More detail in [AIP-160](https://google.aip.dev/160). + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Servingprofiles$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Servingprofiles$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Servingprofiles$Operations$List extends StandardParameters { + /** + * The standard list filter. */ filter?: string; /** - * 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`. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * 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. + * The standard list page size. */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list SessionService.ListEvents call. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the session to list events from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sessions/{session\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Servingprofiles$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Projects$Locations$Reasoningengines$Sessions$Operations { + export class Resource$Projects$Locations$Skills { + context: APIRequestContext; + operations: Resource$Projects$Locations$Skills$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Skills$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Skills$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -147166,13 +164925,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.skills.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -147192,31 +164948,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Skills$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel + | Params$Resource$Projects$Locations$Skills$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147232,13 +164988,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Skills$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Skills$Operations$Cancel; options = {}; } @@ -147302,13 +165058,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.skills.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -147328,31 +165081,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Skills$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params?: Params$Resource$Projects$Locations$Skills$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Skills$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Skills$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Projects$Locations$Skills$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete + | Params$Resource$Projects$Locations$Skills$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147368,13 +165121,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Skills$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete; + {} as Params$Resource$Projects$Locations$Skills$Operations$Delete; options = {}; } @@ -147438,13 +165191,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.skills.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -147470,27 +165220,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Skills$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params?: Params$Resource$Projects$Locations$Skills$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Skills$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Skills$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Projects$Locations$Skills$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -147498,7 +165247,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get + | Params$Resource$Projects$Locations$Skills$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147514,13 +165263,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; + {}) as Params$Resource$Projects$Locations$Skills$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Skills$Operations$Get; options = {}; } @@ -147584,21 +165332,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.skills.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/skills/my-skill', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -147622,29 +165367,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Projects$Locations$Skills$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + params?: Params$Resource$Projects$Locations$Skills$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Projects$Locations$Skills$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Projects$Locations$Skills$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Projects$Locations$Skills$Operations$List, callback: BodyResponseCallback ): void; list( @@ -147652,7 +165397,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List + | Params$Resource$Projects$Locations$Skills$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147670,13 +165415,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; + {}) as Params$Resource$Projects$Locations$Skills$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List; + {} as Params$Resource$Projects$Locations$Skills$Operations$List; options = {}; } @@ -147745,15 +165490,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.reasoningEngines.sessions.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.skills.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -147779,27 +165521,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Skills$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params?: Params$Resource$Projects$Locations$Skills$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Skills$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Skills$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Projects$Locations$Skills$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -147807,7 +165548,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait + | Params$Resource$Projects$Locations$Skills$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -147823,13 +165564,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Skills$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait; + {} as Params$Resource$Projects$Locations$Skills$Operations$Wait; options = {}; } @@ -147864,25 +165605,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Skills$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Skills$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Skills$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Skills$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -147904,7 +165645,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Skills$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -147915,18 +165656,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Schedules { + export class Resource$Projects$Locations$Specialistpools { context: APIRequestContext; - operations: Resource$Projects$Locations$Schedules$Operations; + operations: Resource$Projects$Locations$Specialistpools$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Schedules$Operations( - this.context - ); + this.operations = + new Resource$Projects$Locations$Specialistpools$Operations( + this.context + ); } /** - * Creates a Schedule. + * Creates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -147955,34 +165697,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.create({ - * // Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.specialistPools.create({ + * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * }, * }); @@ -147990,26 +165718,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -148026,56 +165739,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Schedules$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Schedules$Create, + params?: Params$Resource$Projects$Locations$Specialistpools$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Schedules$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Schedules$Create, + params: Params$Resource$Projects$Locations$Specialistpools$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Schedules$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Create; + {}) as Params$Resource$Projects$Locations$Specialistpools$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Create; + params = + {} as Params$Resource$Projects$Locations$Specialistpools$Create; options = {}; } @@ -148088,7 +165801,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( /([^:]\/)\/+/g, '$1' ), @@ -148103,19 +165816,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Schedule. + * Deletes a SpecialistPool as well as all Specialists in the pool. * @example * ```js * // Before running the sample: @@ -148144,9 +165855,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.delete({ - * // Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * const res = await aiplatform.projects.locations.specialistPools.delete({ + * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + * force: 'placeholder-value', + * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', * }); * console.log(res.data); * @@ -148173,27 +165886,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Schedules$Delete, + params?: Params$Resource$Projects$Locations$Specialistpools$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Delete, callback: BodyResponseCallback ): void; delete( @@ -148201,7 +165913,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Delete + | Params$Resource$Projects$Locations$Specialistpools$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -148217,12 +165929,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Delete; + {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Delete; + params = + {} as Params$Resource$Projects$Locations$Specialistpools$Delete; options = {}; } @@ -148257,7 +165970,7 @@ export namespace aiplatform_v1 { } /** - * Gets a Schedule. + * Gets a SpecialistPool. * @example * ```js * // Before running the sample: @@ -148286,34 +165999,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.get({ - * // Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', + * const res = await aiplatform.projects.locations.specialistPools.get({ + * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', * }); * console.log(res.data); * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * } * @@ -148330,56 +166029,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Schedules$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Schedules$Get, + params?: Params$Resource$Projects$Locations$Specialistpools$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Schedules$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Get; + {}) as Params$Resource$Projects$Locations$Specialistpools$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Get; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; options = {}; } @@ -148404,19 +166107,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Schedules in a Location. + * Lists SpecialistPools in a Location. * @example * ```js * // Before running the sample: @@ -148445,24 +166148,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.list({ - * // Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` - * filter: 'placeholder-value', - * // A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` - * orderBy: 'placeholder-value', - * // The standard list page size. Default to 100 if not specified. + * const res = await aiplatform.projects.locations.specialistPools.list({ + * // The standard list page size. * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. FieldMask represents a set of + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "schedules": [] + * // "specialistPools": [] * // } * } * @@ -148479,60 +166180,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Schedules$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Schedules$List, + params?: Params$Resource$Projects$Locations$Specialistpools$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Schedules$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$List, + params: Params$Resource$Projects$Locations$Specialistpools$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$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$Schedules$List; + {}) as Params$Resource$Projects$Locations$Specialistpools$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$List; + params = {} as Params$Resource$Projects$Locations$Specialistpools$List; options = {}; } @@ -148545,7 +166246,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/schedules').replace( + url: (rootUrl + '/v1/{+parent}/specialistPools').replace( /([^:]\/)\/+/g, '$1' ), @@ -148560,19 +166261,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an active or paused Schedule. When the Schedule is updated, new runs will be scheduled starting from the updated next execution time after the update time based on the time_specification in the updated Schedule. All unstarted runs before the update time will be skipped while already created runs will NOT be paused or canceled. + * Updates a SpecialistPool. * @example * ```js * // Before running the sample: @@ -148601,36 +166302,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.patch({ - * // Immutable. The resource name of the Schedule. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // Required. The update mask applies to the resource. See google.protobuf.FieldMask. + * const res = await aiplatform.projects.locations.specialistPools.patch({ + * // Required. The resource name of the SpecialistPool. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // Required. The update mask applies to the resource. * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "pendingDataLabelingJobs": [], + * // "specialistManagerEmails": [], + * // "specialistManagersCount": 0, + * // "specialistWorkerEmails": [] * // } * }, * }); @@ -148638,26 +166325,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "allowQueueing": false, - * // "catchUp": false, - * // "createNotebookExecutionJobRequest": {}, - * // "createPipelineJobRequest": {}, - * // "createTime": "my_createTime", - * // "cron": "my_cron", - * // "displayName": "my_displayName", - * // "endTime": "my_endTime", - * // "lastPauseTime": "my_lastPauseTime", - * // "lastResumeTime": "my_lastResumeTime", - * // "lastScheduledRunResponse": {}, - * // "maxConcurrentActiveRunCount": "my_maxConcurrentActiveRunCount", - * // "maxConcurrentRunCount": "my_maxConcurrentRunCount", - * // "maxRunCount": "my_maxRunCount", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "nextRunTime": "my_nextRunTime", - * // "startTime": "my_startTime", - * // "startedRunCount": "my_startedRunCount", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -148674,56 +166346,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Schedules$Patch, + params?: Params$Resource$Projects$Locations$Specialistpools$Patch, options?: MethodOptions - ): Promise>; + ): Promise>; patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, + params: Params$Resource$Projects$Locations$Specialistpools$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Schedules$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Specialistpools$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Specialistpools$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Patch; + {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Patch; + params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; options = {}; } @@ -148748,380 +166419,78 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule is paused, no new runs will be created. Already created runs will NOT be paused or canceled. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.schedules.pause({ - * // Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); - * console.log(res.data); - * - * // Example 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. - */ - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - options: StreamMethodOptions - ): Promise>; - pause( - params?: Params$Resource$Projects$Locations$Schedules$Pause, - options?: MethodOptions - ): Promise>; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pause( - params: Params$Resource$Projects$Locations$Schedules$Pause, - callback: BodyResponseCallback - ): void; - pause(callback: BodyResponseCallback): void; - pause( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Pause - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Pause; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Pause; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:pause').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); - } - } - - /** - * Resumes a paused Schedule to start scheduling new runs. Will mark Schedule.state to 'ACTIVE'. Only paused Schedule can be resumed. When the Schedule is resumed, new runs will be scheduled starting from the next execution time after the current time based on the time_specification in the Schedule. If Schedule.catch_up is set up true, all missed runs will be scheduled for backfill first. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.schedules.resume({ - * // Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "catchUp": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example 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. - */ - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - options: StreamMethodOptions - ): Promise>; - resume( - params?: Params$Resource$Projects$Locations$Schedules$Resume, - options?: MethodOptions - ): Promise>; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resume( - params: Params$Resource$Projects$Locations$Schedules$Resume, - callback: BodyResponseCallback - ): void; - resume(callback: BodyResponseCallback): void; - resume( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Resume - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Resume; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Schedules$Resume; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Schedules$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Create extends StandardParameters { /** - * Required. The resource name of the Location to create the Schedule in. Format: `projects/{project\}/locations/{location\}` + * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export interface Params$Resource$Projects$Locations$Schedules$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Delete extends StandardParameters { /** - * Required. The name of the Schedule resource to be deleted. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Schedules$Get extends StandardParameters { + force?: boolean; /** - * Required. The name of the Schedule resource. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$List extends StandardParameters { - /** - * Lists the Schedules that match the filter expression. The following fields are supported: * `display_name`: Supports `=`, `!=` comparisons, and `:` wildcard. * `state`: Supports `=` and `!=` comparisons. * `request`: Supports existence of the check. (e.g. `create_pipeline_job_request:*` --\> Schedule has create_pipeline_job_request). * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `start_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `end_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, `\>=` comparisons and `:*` existence check. Values must be in RFC 3339 format. * `next_run_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. Filter expressions can be combined together using logical operators (`NOT`, `AND` & `OR`). The syntax to define filter expression is based on https://google.aip.dev/160. Examples: * `state="ACTIVE" AND display_name:"my_schedule_*"` * `NOT display_name="my_schedule"` * `create_time\>"2021-05-18T00:00:00Z"` * `end_time\>"2021-05-18T00:00:00Z" OR NOT end_time:*` * `create_pipeline_job_request:*` - */ - filter?: string; + export interface Params$Resource$Projects$Locations$Specialistpools$Get extends StandardParameters { /** - * A comma-separated list of fields to order by. The default sort order is in ascending order. Use "desc" after a field name for descending. You can have multiple order_by fields provided. For example, using "create_time desc, end_time" will order results by create time in descending order, and if there are multiple schedules having the same create time, order them by the end time in ascending order. If order_by is not specified, it will order by default with create_time in descending order. Supported fields: * `create_time` * `start_time` * `end_time` * `next_run_time` + * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. */ - orderBy?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Specialistpools$List extends StandardParameters { /** - * The standard list page size. Default to 100 if not specified. + * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListSchedulesResponse.next_page_token of the previous ScheduleService.ListSchedules call. + * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. */ pageToken?: string; /** - * Required. The resource name of the Location to list the Schedules from. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Schedules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Schedule. - */ - name?: string; - /** - * Required. The update mask applies to the resource. See google.protobuf.FieldMask. - */ - updateMask?: string; - - /** - * Request body metadata + * Mask specifying which fields to read. FieldMask represents a set of */ - requestBody?: Schema$GoogleCloudAiplatformV1Schedule; + readMask?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Pause extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Patch extends StandardParameters { /** - * Required. The name of the Schedule resource to be paused. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The resource name of the SpecialistPool. */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1PauseScheduleRequest; - } - export interface Params$Resource$Projects$Locations$Schedules$Resume extends StandardParameters { /** - * Required. The name of the Schedule resource to be resumed. Format: `projects/{project\}/locations/{location\}/schedules/{schedule\}` + * Required. The update mask applies to the resource. */ - name?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1ResumeScheduleRequest; + requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; } - export class Resource$Projects$Locations$Schedules$Operations { + export class Resource$Projects$Locations$Specialistpools$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -149157,10 +166526,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -149180,31 +166550,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Schedules$Operations$Cancel, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Cancel + | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149220,13 +166590,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; options = {}; } @@ -149290,10 +166660,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -149313,31 +166684,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Schedules$Operations$Delete, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Delete + | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149353,13 +166724,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Delete; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; options = {}; } @@ -149423,10 +166794,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -149452,27 +166824,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Schedules$Operations$Get, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -149480,7 +166851,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Get + | Params$Resource$Projects$Locations$Specialistpools$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149496,13 +166867,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Get; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; options = {}; } @@ -149566,18 +166937,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -149601,29 +166973,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Schedules$Operations$List, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Schedules$Operations$List, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, callback: BodyResponseCallback ): void; list( @@ -149631,7 +167003,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$List + | Params$Resource$Projects$Locations$Specialistpools$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149649,13 +167021,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$List; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$List; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; options = {}; } @@ -149724,12 +167096,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.schedules.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/schedules/my-schedule/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.specialistPools.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -149755,27 +167128,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Schedules$Operations$Wait, + params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -149783,7 +167155,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Schedules$Operations$Wait + | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -149799,13 +167171,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Schedules$Operations$Wait; + {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; options = {}; } @@ -149840,25 +167212,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -149880,7 +167252,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Schedules$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -149891,25 +167263,22 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Skills { + export class Resource$Projects$Locations$Studies { context: APIRequestContext; - operations: Resource$Projects$Locations$Skills$Operations; + operations: Resource$Projects$Locations$Studies$Operations; + trials: Resource$Projects$Locations$Studies$Trials; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Skills$Operations( + this.operations = new Resource$Projects$Locations$Studies$Operations( + this.context + ); + this.trials = new Resource$Projects$Locations$Studies$Trials( this.context ); - } - } - - export class Resource$Projects$Locations$Skills$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Creates a Study. A resource name will be generated after creation of the Study. * @example * ```js * // Before running the sample: @@ -149938,14 +167307,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.skills.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.create({ + * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", + * // "name": "my_name", + * // "state": "my_state", + * // "studySpec": {} + * // } * } * * main().catch(e => { @@ -149960,54 +167349,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Skills$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Studies$Create, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Skills$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Skills$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Skills$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Skills$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Studies$Create; options = {}; } @@ -150020,29 +167412,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/studies').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Study. * @example * ```js * // Before running the sample: @@ -150071,9 +167468,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.skills.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.delete({ + * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * @@ -150094,31 +167491,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Skills$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Skills$Operations$Delete, + params?: Params$Resource$Projects$Locations$Studies$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Skills$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Skills$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Skills$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Skills$Operations$Delete + | Params$Resource$Projects$Locations$Studies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -150134,13 +167531,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Skills$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Skills$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Studies$Delete; options = {}; } @@ -150175,7 +167571,7 @@ export namespace aiplatform_v1 { } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets a Study by name. * @example * ```js * // Before running the sample: @@ -150204,19 +167600,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.skills.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', + * const res = await aiplatform.projects.locations.studies.get({ + * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "response": {} + * // "state": "my_state", + * // "studySpec": {} * // } * } * @@ -150233,56 +167630,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Skills$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Skills$Operations$Get, + params?: Params$Resource$Projects$Locations$Studies$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Skills$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Skills$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Skills$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Skills$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Skills$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Skills$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Studies$Get; options = {}; } @@ -150307,17 +167704,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all the studies in a region for an associated project. * @example * ```js * // Before running the sample: @@ -150346,25 +167745,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.skills.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/skills/my-skill', - * // The standard list page size. + * const res = await aiplatform.projects.locations.studies.list({ + * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. * pageSize: 'placeholder-value', - * // The standard list page token. + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "studies": [] * // } * } * @@ -150381,61 +167775,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Skills$Operations$List, + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Skills$Operations$List, + params?: Params$Resource$Projects$Locations$Studies$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Skills$Operations$List, + params: Params$Resource$Projects$Locations$Studies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Skills$Operations$List, + params: Params$Resource$Projects$Locations$Studies$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Skills$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Skills$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$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$Skills$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Skills$Operations$List; + params = {} as Params$Resource$Projects$Locations$Studies$List; options = {}; } @@ -150448,7 +167841,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/studies').replace( /([^:]\/)\/+/g, '$1' ), @@ -150458,24 +167851,24 @@ export namespace aiplatform_v1 { 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 ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. * @example * ```js * // Before running the sample: @@ -150504,21 +167897,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.skills.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/skills/my-skill/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.projects.locations.studies.lookup({ + * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "displayName": "my_displayName" + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "inactiveReason": "my_inactiveReason", * // "name": "my_name", - * // "response": {} + * // "state": "my_state", + * // "studySpec": {} * // } * } * @@ -150534,58 +167934,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Skills$Operations$Wait, + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Skills$Operations$Wait, + lookup( + params?: Params$Resource$Projects$Locations$Studies$Lookup, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Skills$Operations$Wait, + ): Promise>; + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Skills$Operations$Wait, + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Skills$Operations$Wait, - callback: BodyResponseCallback + lookup( + params: Params$Resource$Projects$Locations$Studies$Lookup, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + lookup( + callback: BodyResponseCallback ): void; - wait( + lookup( paramsOrCallback?: - | Params$Resource$Projects$Locations$Skills$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Lookup + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Skills$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Lookup; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Skills$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Studies$Lookup; options = {}; } @@ -150598,92 +167997,90 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Skills$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Skills$Operations$Delete extends StandardParameters { + parent?: string; + /** - * The name of the operation resource to be deleted. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1Study; } - export interface Params$Resource$Projects$Locations$Skills$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Delete extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Skills$Operations$List extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; + export interface Params$Resource$Projects$Locations$Studies$Get extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$List extends StandardParameters { /** - * The standard list page size. + * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` */ - returnPartialSuccess?: boolean; + parent?: string; } - export interface Params$Resource$Projects$Locations$Skills$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Lookup extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; } - export class Resource$Projects$Locations$Specialistpools { + export class Resource$Projects$Locations$Studies$Operations { context: APIRequestContext; - operations: Resource$Projects$Locations$Specialistpools$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Specialistpools$Operations( - this.context - ); } /** - * Creates a SpecialistPool. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -150712,33 +168109,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.create({ - * // Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] - * // } - * }, + * const res = await aiplatform.projects.locations.studies.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -150753,58 +168131,54 @@ export namespace aiplatform_v1 { * @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$Specialistpools$Create, + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Specialistpools$Create, + cancel( + params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Specialistpools$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Create; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Create; + {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; options = {}; } @@ -150817,32 +168191,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a SpecialistPool as well as all Specialists in the pool. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -150871,22 +168242,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.delete({ - * // If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) - * force: 'placeholder-value', - * // Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * const res = await aiplatform.projects.locations.studies.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -150902,57 +168265,53 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Delete, + params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Specialistpools$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Delete; + {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; options = {}; } @@ -150977,17 +168336,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a SpecialistPool. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -151016,20 +168375,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.get({ - * // Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', + * const res = await aiplatform.projects.locations.studies.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "displayName": "my_displayName", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] + * // "response": {} * // } * } * @@ -151046,60 +168404,56 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Specialistpools$Get, + params?: Params$Resource$Projects$Locations$Studies$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; + ): Promise>; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, + params: Params$Resource$Projects$Locations$Studies$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Specialistpools$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Get; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Get; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Get; options = {}; } @@ -151124,19 +168478,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists SpecialistPools in a Location. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -151165,22 +168517,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.list({ + * const res = await aiplatform.projects.locations.studies.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie', * // The standard list page size. * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. + * // The standard list page token. * pageToken: 'placeholder-value', - * // Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. FieldMask represents a set of - * readMask: '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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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", - * // "specialistPools": [] + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -151197,60 +168552,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Specialistpools$List, + params?: Params$Resource$Projects$Locations$Studies$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, + params: Params$Resource$Projects$Locations$Studies$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Specialistpools$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Studies$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Operations$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$Specialistpools$List; + {}) as Params$Resource$Projects$Locations$Studies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$List; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$List; options = {}; } @@ -151263,7 +168619,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/specialistPools').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -151273,24 +168629,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a SpecialistPool. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -151319,24 +168675,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.specialistPools.patch({ - * // Required. The resource name of the SpecialistPool. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // Required. The update mask applies to the resource. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "pendingDataLabelingJobs": [], - * // "specialistManagerEmails": [], - * // "specialistManagersCount": 0, - * // "specialistWorkerEmails": [] - * // } - * }, + * const res = await aiplatform.projects.locations.studies.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -151362,36 +168705,35 @@ export namespace aiplatform_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$Specialistpools$Patch, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Specialistpools$Patch, + wait( + params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Specialistpools$Patch, + wait( + params: Params$Resource$Projects$Locations$Studies$Operations$Wait, callback: BodyResponseCallback ): void; - patch( + wait( callback: BodyResponseCallback ): void; - patch( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Patch + | Params$Resource$Projects$Locations$Studies$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -151407,12 +168749,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Patch; + {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Specialistpools$Patch; + params = + {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; options = {}; } @@ -151425,8 +168768,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -151447,75 +168790,68 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Specialistpools$Create extends StandardParameters { - /** - * Required. The parent Project name for the new SpecialistPool. The form is `projects/{project\}/locations/{location\}`. - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$Delete extends StandardParameters { /** - * If set to true, any specialist managers in this SpecialistPool will also be deleted. (Otherwise, the request will only work if the SpecialistPool has no specialist managers.) + * The name of the operation resource to be deleted. */ - force?: boolean; + name?: string; + } + export interface Params$Resource$Projects$Locations$Studies$Operations$Get extends StandardParameters { /** - * Required. The resource name of the SpecialistPool to delete. Format: `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Specialistpools$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$List extends StandardParameters { /** - * Required. The name of the SpecialistPool resource. The form is `projects/{project\}/locations/{location\}/specialistPools/{specialist_pool\}`. + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Specialistpools$List extends StandardParameters { /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained by ListSpecialistPoolsResponse.next_page_token of the previous SpecialistPoolService.ListSpecialistPools call. Return first page if empty. + * The standard list page token. */ pageToken?: string; /** - * Required. The name of the SpecialistPool's parent resource. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. FieldMask represents a set of + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Specialistpools$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Operations$Wait extends StandardParameters { /** - * Required. The resource name of the SpecialistPool. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. The update mask applies to the resource. - */ - updateMask?: string; - - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1SpecialistPool; + timeout?: string; } - export class Resource$Projects$Locations$Specialistpools$Operations { + export class Resource$Projects$Locations$Studies$Trials { context: APIRequestContext; + operations: Resource$Projects$Locations$Studies$Trials$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Studies$Trials$Operations(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. * @example * ```js * // Before running the sample: @@ -151545,14 +168881,36 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', + * await aiplatform.projects.locations.studies.trials.addTrialMeasurement({ + * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "measurement": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } * } * * main().catch(e => { @@ -151567,54 +168925,58 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + addTrialMeasurement( + params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, + ): Promise>; + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel, - callback: BodyResponseCallback + addTrialMeasurement( + params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + addTrialMeasurement( + callback: BodyResponseCallback + ): void; + addTrialMeasurement( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; options = {}; } @@ -151627,29 +168989,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. * @example * ```js * // Before running the sample: @@ -151679,14 +169046,29 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.specialistPools.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * await aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( + * { + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * trialName: + * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -151701,54 +169083,57 @@ export namespace aiplatform_v1 { * @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$Specialistpools$Operations$Delete, + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + checkTrialEarlyStoppingState( + params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, + ): Promise>; + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Delete, - callback: BodyResponseCallback + checkTrialEarlyStoppingState( + params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + checkTrialEarlyStoppingState( + callback: BodyResponseCallback + ): void; + checkTrialEarlyStoppingState( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Delete; + {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; options = {}; } @@ -151761,29 +169146,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['trialName'], + pathParams: ['trialName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Marks a Trial as complete. * @example * ```js * // Before running the sample: @@ -151812,20 +169199,36 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.studies.trials.complete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "finalMeasurement": {}, + * // "infeasibleReason": "my_infeasibleReason", + * // "trialInfeasible": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", - * // "response": {} + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -151841,58 +169244,58 @@ export namespace aiplatform_v1 { * @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$Specialistpools$Operations$Get, + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + complete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + ): Promise>; + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Get, - callback: BodyResponseCallback + complete( + params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + complete( + callback: BodyResponseCallback ): void; - get( + complete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Complete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Get; + {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; options = {}; } @@ -151905,8 +169308,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:complete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -151917,17 +169323,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Adds a user provided Trial to a Study. * @example * ```js * // Before running the sample: @@ -151956,26 +169364,45 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.studies.trials.create({ + * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -151991,62 +169418,57 @@ export namespace aiplatform_v1 { * @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$Specialistpools$Operations$List, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Studies$Trials$Create, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Studies$Trials$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$List; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; options = {}; } @@ -152059,34 +169481,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+parent}/trials').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, 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 ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a Trial. * @example * ```js * // Before running the sample: @@ -152115,23 +169537,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.specialistPools.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/specialistPools/my-specialistPool/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.studies.trials.delete({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -152146,58 +169559,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Specialistpools$Operations$Wait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + callback: BodyResponseCallback ): void; - wait( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Specialistpools$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Specialistpools$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; options = {}; } @@ -152210,8 +169618,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -152222,83 +169630,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Specialistpools$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Specialistpools$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Studies { - context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Operations; - trials: Resource$Projects$Locations$Studies$Trials; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Studies$Operations( - this.context - ); - this.trials = new Resource$Projects$Locations$Studies$Trials( - this.context - ); - } /** - * Creates a Study. A resource name will be generated after creation of the Study. + * Gets a Trial. * @example * ```js * // Before running the sample: @@ -152327,33 +169669,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.create({ - * // Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", - * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} - * // } - * }, + * const res = await aiplatform.projects.locations.studies.trials.get({ + * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", * // "state": "my_state", - * // "studySpec": {} + * // "webAccessUris": {} * // } * } * @@ -152369,57 +169704,57 @@ export namespace aiplatform_v1 { * @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$Studies$Create, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Studies$Create, + get( + params?: Params$Resource$Projects$Locations$Studies$Trials$Get, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Studies$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Create, + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Studies$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Studies$Trials$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Create; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Create; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; options = {}; } @@ -152432,34 +169767,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Study. + * Lists the Trials associated with a Study. * @example * ```js * // Before running the sample: @@ -152488,14 +169820,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.delete({ - * // Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.studies.trials.list({ + * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * pageSize: 'placeholder-value', + * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "trials": [] + * // } * } * * main().catch(e => { @@ -152510,53 +169849,61 @@ export namespace aiplatform_v1 { * @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$Studies$Delete, + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Delete, + list( + params?: Params$Resource$Projects$Locations$Studies$Trials$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Studies$Trials$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Delete; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; options = {}; } @@ -152569,29 +169916,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/trials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Study by name. + * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency * @example * ```js * // Before running the sample: @@ -152620,20 +169972,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.get({ - * // Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ + * // Required. The name of the Study that the optimal Trial belongs to. + * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", - * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "optimalTrials": [] * // } * } * @@ -152649,57 +170003,62 @@ export namespace aiplatform_v1 { * @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$Studies$Get, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Get, + listOptimalTrials( + params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Get, + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Get, - callback: BodyResponseCallback + listOptimalTrials( + params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + listOptimalTrials( + callback: BodyResponseCallback ): void; - get( + listOptimalTrials( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Get; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; options = {}; } @@ -152712,31 +170071,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, 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 ); } } /** - * Lists all the studies in a region for an associated project. + * Stops a Trial. * @example * ```js * // Before running the sample: @@ -152765,20 +170127,32 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.list({ - * // Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. - * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.studies.trials.stop({ + * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "studies": [] + * // "clientId": "my_clientId", + * // "customJob": "my_customJob", + * // "endTime": "my_endTime", + * // "finalMeasurement": {}, + * // "id": "my_id", + * // "infeasibleReason": "my_infeasibleReason", + * // "measurements": [], + * // "name": "my_name", + * // "parameters": [], + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "webAccessUris": {} * // } * } * @@ -152794,61 +170168,57 @@ export namespace aiplatform_v1 { * @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$Studies$List, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$List, + stop( + params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Studies$List, + ): Promise>; + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$List, + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$List, - callback: BodyResponseCallback + stop( + params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + stop( + callback: BodyResponseCallback ): void; - list( + stop( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Stop + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$List; + params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; options = {}; } @@ -152861,34 +170231,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Looks a study up using the user-defined display_name field instead of the fully qualified resource name. + * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. * @example * ```js * // Before running the sample: @@ -152917,15 +170284,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.lookup({ - * // Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.projects.locations.studies.trials.suggest({ + * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * parent: 'projects/my-project/locations/my-location/studies/my-studie', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "displayName": "my_displayName" + * // "clientId": "my_clientId", + * // "contexts": [], + * // "suggestionCount": 0 * // } * }, * }); @@ -152933,12 +170302,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "inactiveReason": "my_inactiveReason", + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "state": "my_state", - * // "studySpec": {} + * // "response": {} * // } * } * @@ -152954,57 +170322,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions ): Promise>; - lookup( - params?: Params$Resource$Projects$Locations$Studies$Lookup, + suggest( + params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options?: MethodOptions - ): Promise>; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + ): Promise>; + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - lookup( - params: Params$Resource$Projects$Locations$Studies$Lookup, - callback: BodyResponseCallback + suggest( + params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + callback: BodyResponseCallback ): void; - lookup( - callback: BodyResponseCallback + suggest( + callback: BodyResponseCallback ): void; - lookup( + suggest( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Lookup - | BodyResponseCallback + | Params$Resource$Projects$Locations$Studies$Trials$Suggest + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Lookup; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Lookup; + params = + {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; options = {}; } @@ -153017,7 +170385,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/studies:lookup').replace( + url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( /([^:]\/)\/+/g, '$1' ), @@ -153032,44 +170400,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Studies$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement extends StandardParameters { /** - * Required. The resource name of the Location to create the CustomJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + trialName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + trialName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Complete extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Create extends StandardParameters { + /** + * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1Study; + requestBody?: Schema$GoogleCloudAiplatformV1Trial; } - export interface Params$Resource$Projects$Locations$Studies$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Delete extends StandardParameters { /** - * Required. The name of the Study resource to be deleted. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Get extends StandardParameters { /** - * Required. The name of the Study resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$List extends StandardParameters { /** - * Optional. The maximum number of studies to return per "page" of results. If unspecified, service will pick an appropriate default. + * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. */ pageSize?: number; /** @@ -153077,23 +170476,45 @@ export namespace aiplatform_v1 { */ pageToken?: string; /** - * Required. The resource name of the Location to list the Study from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Studies$Lookup extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials extends StandardParameters { /** - * Required. The resource name of the Location to get the Study from. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the Study that the optimal Trial belongs to. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1LookupStudyRequest; + requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; + } + export interface Params$Resource$Projects$Locations$Studies$Trials$Stop extends StandardParameters { + /** + * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; } + export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest extends StandardParameters { + /** + * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + */ + parent?: string; - export class Resource$Projects$Locations$Studies$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + } + + export class Resource$Projects$Locations$Studies$Trials$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -153129,10 +170550,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -153152,31 +170574,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Studies$Operations$Cancel, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Cancel + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153192,13 +170614,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; options = {}; } @@ -153262,10 +170684,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -153285,31 +170708,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Operations$Delete, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Delete + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153325,13 +170748,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Delete; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; options = {}; } @@ -153395,10 +170818,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.studies.trials.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -153424,27 +170849,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Operations$Get, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Operations$Get, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -153452,7 +170876,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Get + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153468,13 +170892,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Get; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Get; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; options = {}; } @@ -153538,18 +170962,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -153573,29 +170998,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$Operations$List, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Operations$List, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, callback: BodyResponseCallback ): void; list( @@ -153603,7 +171028,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$List + | Params$Resource$Projects$Locations$Studies$Trials$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153621,13 +171046,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$List; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$List; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; options = {}; } @@ -153696,12 +171121,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.studies.trials.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -153727,27 +171153,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Studies$Operations$Wait, + params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -153755,7 +171180,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Operations$Wait + | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -153771,13 +171196,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Operations$Wait; + {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; options = {}; } @@ -153812,25 +171237,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Studies$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -153852,7 +171277,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Studies$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -153863,337 +171288,21 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Studies$Trials { + export class Resource$Projects$Locations$Tensorboards { context: APIRequestContext; - operations: Resource$Projects$Locations$Studies$Trials$Operations; + experiments: Resource$Projects$Locations$Tensorboards$Experiments; + operations: Resource$Projects$Locations$Tensorboards$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Studies$Trials$Operations(this.context); - } - - /** - * Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.studies.trials.addTrialMeasurement({ - * // Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "measurement": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} - * // } - * } - * - * 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. - */ - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - options: StreamMethodOptions - ): Promise>; - addTrialMeasurement( - params?: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - options?: MethodOptions - ): Promise>; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - addTrialMeasurement( - params: Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement, - callback: BodyResponseCallback - ): void; - addTrialMeasurement( - callback: BodyResponseCallback - ): void; - addTrialMeasurement( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+trialName}:addTrialMeasurement').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['trialName'], - pathParams: ['trialName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.studies.trials.checkTrialEarlyStoppingState( - * { - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * trialName: - * 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }, - * ); - * 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. - */ - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options: StreamMethodOptions - ): Promise>; - checkTrialEarlyStoppingState( - params?: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options?: MethodOptions - ): Promise>; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - params: Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate, - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - callback: BodyResponseCallback - ): void; - checkTrialEarlyStoppingState( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1/{+trialName}:checkTrialEarlyStoppingState' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['trialName'], - pathParams: ['trialName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + this.experiments = + new Resource$Projects$Locations$Tensorboards$Experiments(this.context); + this.operations = new Resource$Projects$Locations$Tensorboards$Operations( + this.context + ); } /** - * Marks a Trial as complete. + * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. * @example * ```js * // Before running the sample: @@ -154222,36 +171331,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.complete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "finalMeasurement": {}, - * // "infeasibleReason": "my_infeasibleReason", - * // "trialInfeasible": false - * // } - * }, + * const res = await aiplatform.projects.locations.tensorboards.batchRead({ + * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "timeSeriesData": [] * // } * } * @@ -154267,58 +171358,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: StreamMethodOptions ): Promise>; - complete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Complete, + batchRead( + params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, options?: MethodOptions - ): Promise>; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - complete( - params: Params$Resource$Projects$Locations$Studies$Trials$Complete, - callback: BodyResponseCallback + batchRead( + params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + callback: BodyResponseCallback ): void; - complete( - callback: BodyResponseCallback + batchRead( + callback: BodyResponseCallback ): void; - complete( + batchRead( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Complete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Batchread + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Complete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Batchread; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Complete; + {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; options = {}; } @@ -154331,34 +171426,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:complete').replace( + url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds a user provided Trial to a Study. + * Creates a Tensorboard. * @example * ```js * // Before running the sample: @@ -154387,26 +171482,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.create({ - * // Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.tensorboards.create({ + * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * }, * }); @@ -154414,18 +171510,11 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "done": false, + * // "error": {}, + * // "metadata": {}, * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "response": {} * // } * } * @@ -154442,56 +171531,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Studies$Trials$Create, + params?: Params$Resource$Projects$Locations$Tensorboards$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Create, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Studies$Trials$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Create; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; options = {}; } @@ -154504,7 +171592,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( /([^:]\/)\/+/g, '$1' ), @@ -154519,19 +171607,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Trial. + * Deletes a Tensorboard. * @example * ```js * // Before running the sample: @@ -154560,14 +171646,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.delete({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.tensorboards.delete({ + * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -154583,52 +171675,55 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Delete, options?: MethodOptions - ): Promise>; + ): Promise>; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Delete, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Delete; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; options = {}; } @@ -154653,17 +171748,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Trial. + * Gets a Tensorboard. * @example * ```js * // Before running the sample: @@ -154684,7 +171779,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -154692,26 +171790,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.get({ - * // Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', + * const res = await aiplatform.projects.locations.tensorboards.get({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" * // } * } * @@ -154728,56 +171827,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Get, options?: MethodOptions - ): Promise>; + ): Promise< + GaxiosResponseWithHTTP2 + >; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Studies$Trials$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Get; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; options = {}; } @@ -154802,19 +171905,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists the Trials associated with a Study. + * Lists Tensorboards in a Location. * @example * ```js * // Before running the sample: @@ -154835,7 +171938,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -154843,20 +171949,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.list({ - * // Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * const res = await aiplatform.projects.locations.tensorboards.list({ + * // Lists the Tensorboards that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. * pageSize: 'placeholder-value', - * // Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "trials": [] + * // "tensorboards": [] * // } * } * @@ -154873,60 +171985,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Studies$Trials$List, + params?: Params$Resource$Projects$Locations$Tensorboards$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, + params: Params$Resource$Projects$Locations$Tensorboards$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Studies$Trials$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$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$Studies$Trials$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$List; + params = {} as Params$Resource$Projects$Locations$Tensorboards$List; options = {}; } @@ -154939,7 +172051,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials').replace( + url: (rootUrl + '/v1/{+parent}/tensorboards').replace( /([^:]\/)\/+/g, '$1' ), @@ -154954,19 +172066,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency + * Updates a Tensorboard. * @example * ```js * // Before running the sample: @@ -154995,22 +172107,41 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.listOptimalTrials({ - * // Required. The name of the Study that the optimal Trial belongs to. - * parent: 'projects/my-project/locations/my-location/studies/my-studie', + * const res = await aiplatform.projects.locations.tensorboards.patch({ + * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "isDefault": false, + * // "labels": {}, + * // "name": "my_name", + * // "runCount": 0, + * // "satisfiesPzi": false, + * // "satisfiesPzs": false, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "optimalTrials": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -155026,62 +172157,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions ): Promise>; - listOptimalTrials( - params?: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listOptimalTrials( - params: Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Patch, + callback: BodyResponseCallback ): void; - listOptimalTrials( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - listOptimalTrials( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; options = {}; } @@ -155094,34 +172219,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:listOptimalTrials').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Stops a Trial. + * Returns the storage size for a given TensorBoard instance. * @example * ```js * // Before running the sample: @@ -155150,32 +172270,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.stop({ - * // Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, + * const res = await aiplatform.projects.locations.tensorboards.readSize({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', * }); * console.log(res.data); * * // Example response * // { - * // "clientId": "my_clientId", - * // "customJob": "my_customJob", - * // "endTime": "my_endTime", - * // "finalMeasurement": {}, - * // "id": "my_id", - * // "infeasibleReason": "my_infeasibleReason", - * // "measurements": [], - * // "name": "my_name", - * // "parameters": [], - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "webAccessUris": {} + * // "storageSizeByte": "my_storageSizeByte" * // } * } * @@ -155191,57 +172295,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: StreamMethodOptions ): Promise>; - stop( - params?: Params$Resource$Projects$Locations$Studies$Trials$Stop, + readSize( + params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, options?: MethodOptions - ): Promise>; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - stop( - params: Params$Resource$Projects$Locations$Studies$Trials$Stop, - callback: BodyResponseCallback + readSize( + params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + callback: BodyResponseCallback ): void; - stop( - callback: BodyResponseCallback + readSize( + callback: BodyResponseCallback ): void; - stop( + readSize( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Stop - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Readsize + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Stop; + {}) as Params$Resource$Projects$Locations$Tensorboards$Readsize; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Studies$Trials$Stop; + params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; options = {}; } @@ -155254,31 +172362,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:stop').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse. + * Returns a list of monthly active users for a given TensorBoard instance. * @example * ```js * // Before running the sample: @@ -155307,29 +172418,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.suggest({ - * // Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - * parent: 'projects/my-project/locations/my-location/studies/my-studie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientId": "my_clientId", - * // "contexts": [], - * // "suggestionCount": 0 - * // } - * }, + * const res = await aiplatform.projects.locations.tensorboards.readUsage({ + * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * tensorboard: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "monthlyUsageData": {} * // } * } * @@ -155345,58 +172443,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions ): Promise>; - suggest( - params?: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + readUsage( + params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, options?: MethodOptions - ): Promise>; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - suggest( - params: Params$Resource$Projects$Locations$Studies$Trials$Suggest, - callback: BodyResponseCallback + readUsage( + params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + callback: BodyResponseCallback ): void; - suggest( - callback: BodyResponseCallback + readUsage( + callback: BodyResponseCallback ): void; - suggest( + readUsage( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Suggest - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Readusage + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Suggest; + {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; options = {}; } @@ -155409,143 +172511,137 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trials:suggest').replace( + url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['tensorboard'], + pathParams: ['tensorboard'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Studies$Trials$Addtrialmeasurement extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Batchread extends StandardParameters { /** - * Required. The name of the trial to add measurement. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. */ - trialName?: string; - + tensorboard?: string; /** - * Request body metadata + * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1AddTrialMeasurementRequest; + timeSeries?: string[]; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Checktrialearlystoppingstate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Create extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` */ - trialName?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CheckTrialEarlyStoppingStateRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Complete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Delete extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CompleteTrialRequest; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Create extends StandardParameters { - /** - * Required. The resource name of the Study to create the Trial in. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Tensorboards$Get extends StandardParameters { /** - * Request body metadata + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1Trial; + name?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$List extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Lists the Tensorboards that match the filter expression. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Get extends StandardParameters { + filter?: string; /** - * Required. The name of the Trial resource. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Field to use to sort the list. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$List extends StandardParameters { + orderBy?: string; /** - * Optional. The number of Trials to retrieve per "page" of results. If unspecified, the service will pick an appropriate default. + * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. */ pageSize?: number; /** - * Optional. A page token to request the next page of results. If unspecified, there are no subsequent pages. + * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Study to list the Trial from. Format: `projects/{project\}/locations/{location\}/studies/{study\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Listoptimaltrials extends StandardParameters { - /** - * Required. The name of the Study that the optimal Trial belongs to. + * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - /** - * Request body metadata + * Mask specifying which fields to read. */ - requestBody?: Schema$GoogleCloudAiplatformV1ListOptimalTrialsRequest; + readMask?: string; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Stop extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Patch extends StandardParameters { /** - * Required. The Trial's name. Format: `projects/{project\}/locations/{location\}/studies/{study\}/trials/{trial\}` + * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1StopTrialRequest; + requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; } - export interface Params$Resource$Projects$Locations$Studies$Trials$Suggest extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Readsize extends StandardParameters { /** - * Required. The project and location that the Study belongs to. Format: `projects/{project\}/locations/{location\}/studies/{study\}` + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - parent?: string; - + tensorboard?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Readusage extends StandardParameters { /** - * Request body metadata + * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` */ - requestBody?: Schema$GoogleCloudAiplatformV1SuggestTrialsRequest; + tensorboard?: string; } - export class Resource$Projects$Locations$Studies$Trials$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments { context: APIRequestContext; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; + runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Tensorboards$Experiments$Operations( + this.context + ); + this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -155575,14 +172671,25 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "tensorboardTimeSeries": [] + * // } * } * * main().catch(e => { @@ -155597,54 +172704,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + batchCreate( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; options = {}; } @@ -155657,29 +172772,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -155709,14 +172829,41 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.studies.trials.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', + * await aiplatform.projects.locations.tensorboards.experiments.create({ + * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardExperimentId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -155731,54 +172878,62 @@ export namespace aiplatform_v1 { * @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$Studies$Trials$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; options = {}; } @@ -155791,29 +172946,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/experiments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -155842,12 +173002,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.studies.trials.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * }, - * ); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.delete({ + * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * }); * console.log(res.data); * * // Example response @@ -155872,36 +173031,35 @@ export namespace aiplatform_v1 { * @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$Studies$Trials$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -155917,13 +173075,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; options = {}; } @@ -155937,7 +173095,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -155958,7 +173116,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -155979,7 +173137,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -155987,26 +173148,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.studies.trials.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ + * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -156022,62 +173179,62 @@ export namespace aiplatform_v1 { * @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$Studies$Trials$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get + | 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$Studies$Trials$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; options = {}; } @@ -156090,10 +173247,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -156105,230 +173259,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.studies.trials.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/studies/my-studie/trials/my-trial/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); - * 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. - */ - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: StreamMethodOptions - ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Studies$Trials$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards { - context: APIRequestContext; - experiments: Resource$Projects$Locations$Tensorboards$Experiments; - operations: Resource$Projects$Locations$Tensorboards$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.experiments = - new Resource$Projects$Locations$Tensorboards$Experiments(this.context); - this.operations = new Resource$Projects$Locations$Tensorboards$Operations( - this.context - ); - } /** - * Reads multiple TensorboardTimeSeries' data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned. + * Lists TensorboardExperiments in a Location. * @example * ```js * // Before running the sample: @@ -156349,7 +173292,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -156357,18 +173303,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.batchRead({ - * // Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tensorboards.experiments.list( + * { + * // Lists the TensorboardExperiments that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "timeSeriesData": [] + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardExperiments": [] * // } * } * @@ -156384,62 +173341,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions ): Promise>; - batchRead( - params?: Params$Resource$Projects$Locations$Tensorboards$Batchread, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchRead( - params: Params$Resource$Projects$Locations$Tensorboards$Batchread, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + callback: BodyResponseCallback ): void; - batchRead( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchRead( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Batchread - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$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$Tensorboards$Batchread; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Batchread; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; options = {}; } @@ -156452,7 +173409,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:batchRead').replace( + url: (rootUrl + '/v1/{+parent}/experiments').replace( /([^:]\/)\/+/g, '$1' ), @@ -156462,24 +173419,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Tensorboard. + * Updates a TensorboardExperiment. * @example * ```js * // Before running the sample: @@ -156508,39 +173465,40 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.create({ - * // Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.patch({ + * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "source": "my_source", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "source": "my_source", + * // "updateTime": "my_updateTime" * // } * } * @@ -156556,57 +173514,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Create, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Create, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Create; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; options = {}; } @@ -156619,32 +173582,31 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Tensorboard. + * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -156673,20 +173635,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.delete({ - * // Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.write({ + * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * tensorboardExperiment: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "writeRunDataRequests": [] + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -156701,57 +173667,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Delete, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Delete, + write( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Delete, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - delete( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Delete; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; options = {}; } @@ -156764,29 +173735,132 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardExperiment'], + pathParams: ['tensorboardExperiment'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate extends StandardParameters { /** - * Gets a Tensorboard. + * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create extends StandardParameters { + /** + * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + parent?: string; + /** + * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + */ + tensorboardExperimentId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete extends StandardParameters { + /** + * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get extends StandardParameters { + /** + * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List extends StandardParameters { + /** + * Lists the TensorboardExperiments that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch extends StandardParameters { + /** + * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write extends StandardParameters { + /** + * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + */ + tensorboardExperiment?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -156807,10 +173881,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -156818,28 +173889,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.get({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -156854,61 +173914,54 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Get, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Get, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Get; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; options = {}; } @@ -156921,8 +173974,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -156933,19 +173986,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Tensorboards in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -156966,10 +174017,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -156977,27 +174025,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.list({ - * // Lists the Tensorboards that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboards": [] - * // } + * // {} * } * * main().catch(e => { @@ -157012,61 +174050,54 @@ export namespace aiplatform_v1 { * @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$Tensorboards$List, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$List, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$List; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; options = {}; } @@ -157079,34 +174110,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tensorboards').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Tensorboard. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -157135,32 +174161,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.patch({ - * // Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "blobStoragePathPrefix": "my_blobStoragePathPrefix", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "isDefault": false, - * // "labels": {}, - * // "name": "my_name", - * // "runCount": 0, - * // "satisfiesPzi": false, - * // "satisfiesPzs": false, - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.operations.get( + * { + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -157185,36 +174192,35 @@ export namespace aiplatform_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$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Patch + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -157230,12 +174236,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Patch; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; options = {}; } @@ -157249,7 +174256,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -157270,7 +174277,7 @@ export namespace aiplatform_v1 { } /** - * Returns the storage size for a given TensorBoard instance. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -157299,16 +174306,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readSize({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.operations.list( + * { + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "storageSizeByte": "my_storageSizeByte" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -157324,61 +174343,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions ): Promise>; - readSize( - params?: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readSize( - params: Params$Resource$Projects$Locations$Tensorboards$Readsize, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + callback: BodyResponseCallback ): void; - readSize( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - readSize( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readsize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$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$Tensorboards$Readsize; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tensorboards$Readsize; + params = + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; options = {}; } @@ -157391,7 +174411,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readSize').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -157401,24 +174421,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns a list of monthly active users for a given TensorBoard instance. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -157447,16 +174467,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.readUsage({ - * // Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - * tensorboard: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "monthlyUsageData": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -157472,62 +174500,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions ): Promise>; - readUsage( - params?: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readUsage( - params: Params$Resource$Projects$Locations$Tensorboards$Readusage, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + callback: BodyResponseCallback ): void; - readUsage( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - readUsage( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Readusage - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Readusage; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Readusage; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; options = {}; } @@ -157540,137 +174563,97 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboard}:readUsage').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboard'], - pathParams: ['tensorboard'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Batchread extends StandardParameters { - /** - * Required. The resource name of the Tensorboard containing TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}`. The TensorboardTimeSeries referenced by time_series must be sub resources of this Tensorboard. - */ - tensorboard?: string; - /** - * Required. The resource names of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - timeSeries?: string[]; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the Tensorboard in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete extends StandardParameters { /** - * Required. The name of the Tensorboard to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get extends StandardParameters { /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List extends StandardParameters { /** - * Lists the Tensorboards that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of Tensorboards to return. The service may return fewer than this value. If unspecified, at most 100 Tensorboards are returned. The maximum value is 100; values above 100 are coerced to 100. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboards call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboards must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the Location to list Tensorboards. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait extends StandardParameters { /** - * Output only. Name of the Tensorboard. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the Tensorboard resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1Tensorboard; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readsize extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` - */ - tensorboard?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Readusage extends StandardParameters { - /** - * Required. The name of the Tensorboard resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - tensorboard?: string; + timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Operations; - runs: Resource$Projects$Locations$Tensorboards$Experiments$Runs; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; + timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Operations( + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( + this.context + ); + this.timeSeries = + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( this.context ); - this.runs = new Resource$Projects$Locations$Tensorboards$Experiments$Runs( - this.context - ); } /** - * Batch create TensorboardTimeSeries that belong to a TensorboardExperiment. + * Batch create TensorboardRuns. * @example * ```js * // Before running the sample: @@ -157700,24 +174683,26 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.batchCreate({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( + * { + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "requests": [] - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "requests": [] + * // } + * }, * }, - * }); + * ); * console.log(res.data); * * // Example response * // { - * // "tensorboardTimeSeries": [] + * // "tensorboardRuns": [] * // } * } * @@ -157734,61 +174719,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions ): Promise>; batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, + callback: BodyResponseCallback ): void; batchCreate( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate + | 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$Tensorboards$Experiments$Batchcreate; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; options = {}; } @@ -157801,7 +174786,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}:batchCreate').replace( + url: (rootUrl + '/v1/{+parent}/runs:batchCreate').replace( /([^:]\/)\/+/g, '$1' ), @@ -157816,19 +174801,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a TensorboardExperiment. + * Creates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -157858,12 +174843,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.create({ - * // Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * await aiplatform.projects.locations.tensorboards.experiments.runs.create({ + * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardExperimentId: 'placeholder-value', + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * tensorboardRunId: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -157875,7 +174860,6 @@ export namespace aiplatform_v1 { * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", * // "updateTime": "my_updateTime" * // } * }, @@ -157890,7 +174874,6 @@ export namespace aiplatform_v1 { * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", * // "updateTime": "my_updateTime" * // } * } @@ -157908,61 +174891,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create + | 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$Tensorboards$Experiments$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; options = {}; } @@ -157975,10 +174958,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -157990,19 +174970,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a TensorboardExperiment. + * Deletes a TensorboardRun. * @example * ```js * // Before running the sample: @@ -158032,9 +175012,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.delete({ - * // Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ + * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', * }); * console.log(res.data); * @@ -158061,27 +175041,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, callback: BodyResponseCallback ): void; delete( @@ -158089,7 +175068,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -158105,13 +175084,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; options = {}; } @@ -158146,7 +175125,7 @@ export namespace aiplatform_v1 { } /** - * Gets a TensorboardExperiment. + * Gets a TensorboardRun. * @example * ```js * // Before running the sample: @@ -158178,10 +175157,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.get({ - * // Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * }); + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ + * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * }); * console.log(res.data); * * // Example response @@ -158192,7 +175172,6 @@ export namespace aiplatform_v1 { * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", * // "updateTime": "my_updateTime" * // } * } @@ -158210,61 +175189,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get + | 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$Tensorboards$Experiments$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; options = {}; } @@ -158289,19 +175268,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists TensorboardExperiments in a Location. + * Lists TensorboardRuns in a Location. * @example * ```js * // Before running the sample: @@ -158333,29 +175312,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.experiments.list( - * { - * // Lists the TensorboardExperiments that match the filter expression. + * const res = + * await aiplatform.projects.locations.tensorboards.experiments.runs.list({ + * // Lists the TensorboardRuns that match the filter expression. * filter: 'placeholder-value', * // Field to use to sort the list. * orderBy: 'placeholder-value', - * // The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. * pageToken: 'placeholder-value', - * // Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', * // Mask specifying which fields to read. * readMask: 'placeholder-value', - * }, - * ); + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "tensorboardExperiments": [] + * // "tensorboardRuns": [] * // } * } * @@ -158372,61 +175350,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$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$Tensorboards$Experiments$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; options = {}; } @@ -158439,10 +175417,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/experiments').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -158454,19 +175429,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a TensorboardExperiment. + * Updates a TensorboardRun. * @example * ```js * // Before running the sample: @@ -158496,10 +175471,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.patch({ - * // Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * await aiplatform.projects.locations.tensorboards.experiments.runs.patch({ + * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. * updateMask: 'placeholder-value', * * // Request body metadata @@ -158512,7 +175487,6 @@ export namespace aiplatform_v1 { * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", * // "updateTime": "my_updateTime" * // } * }, @@ -158527,7 +175501,6 @@ export namespace aiplatform_v1 { * // "etag": "my_etag", * // "labels": {}, * // "name": "my_name", - * // "source": "my_source", * // "updateTime": "my_updateTime" * // } * } @@ -158545,61 +175518,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions ): Promise>; patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$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$Tensorboards$Experiments$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; options = {}; } @@ -158624,19 +175597,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's. If any data fail to be ingested, an error is returned. + * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. * @example * ```js * // Before running the sample: @@ -158666,16 +175639,17 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.write({ - * // Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * tensorboardExperiment: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ + * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * tensorboardRun: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "writeRunDataRequests": [] + * // "tensorboardRun": "my_tensorboardRun", + * // "timeSeriesData": [] * // } * }, * }); @@ -158698,61 +175672,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions ): Promise>; write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Write, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + callback: BodyResponseCallback ): void; write( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write + | 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$Tensorboards$Experiments$Write; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Write; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; options = {}; } @@ -158765,7 +175739,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardExperiment}:write').replace( + url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( /([^:]\/)\/+/g, '$1' ), @@ -158775,64 +175749,64 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboardExperiment'], - pathParams: ['tensorboardExperiment'], + requiredParams: ['tensorboardRun'], + pathParams: ['tensorboardRun'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Batchcreate extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate extends StandardParameters { /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The TensorboardRuns referenced by the parent fields in the CreateTensorboardTimeSeriesRequest messages must be sub resources of this TensorboardExperiment. + * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardTimeSeriesRequest; + requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create extends StandardParameters { /** - * Required. The resource name of the Tensorboard to create the TensorboardExperiment in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ parent?: string; /** - * Required. The ID to use for the Tensorboard experiment, which becomes the final component of the Tensorboard experiment's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. + * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. */ - tensorboardExperimentId?: string; + tensorboardRunId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete extends StandardParameters { /** - * Required. The name of the TensorboardExperiment to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get extends StandardParameters { /** - * Required. The name of the TensorboardExperiment resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List extends StandardParameters { /** - * Lists the TensorboardExperiments that match the filter expression. + * Lists the TensorboardRuns that match the filter expression. */ filter?: string; /** @@ -158840,15 +175814,15 @@ export namespace aiplatform_v1 { */ orderBy?: string; /** - * The maximum number of TensorboardExperiments to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardExperiments are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardExperiments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardExperiments must match the call that provided the page token. + * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the Tensorboard to list TensorboardExperiments. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}` + * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` */ parent?: string; /** @@ -158856,34 +175830,34 @@ export namespace aiplatform_v1 { */ readMask?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch extends StandardParameters { /** - * Output only. Name of the TensorboardExperiment. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardExperiment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardExperiment; + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Write extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write extends StandardParameters { /** - * Required. The resource name of the TensorboardExperiment to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` + * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` */ - tensorboardExperiment?: string; + tensorboardRun?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardExperimentDataRequest; + requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Operations { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -158920,10 +175894,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.cancel( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); @@ -158945,31 +175919,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -158985,13 +175959,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; options = {}; } @@ -159056,10 +176030,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.delete( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); @@ -159081,31 +176055,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159121,13 +176095,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; options = {}; } @@ -159192,10 +176166,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.get( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( * { * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * }, * ); * console.log(res.data); @@ -159223,27 +176197,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -159251,7 +176224,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159267,13 +176240,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; options = {}; } @@ -159338,12 +176311,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.list( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( * { * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -159375,29 +176348,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -159405,7 +176378,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159423,13 +176396,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; options = {}; } @@ -159499,10 +176472,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.operations.wait( + * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( * { * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/operations/my-operation', + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }, @@ -159532,27 +176505,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -159560,7 +176532,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -159576,13 +176548,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; options = {}; } @@ -159617,25 +176589,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -159657,7 +176629,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -159668,24 +176640,19 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs { + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations; - timeSeries: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries; + operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations( - this.context - ); - this.timeSeries = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries( + new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( this.context ); } /** - * Batch create TensorboardRuns. + * Creates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -159715,17 +176682,28 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.batchCreate( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( * { - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. + * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + * tensorboardTimeSeriesId: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "requests": [] + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * }, * }, @@ -159734,179 +176712,16 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "tensorboardRuns": [] - * // } - * } - * - * 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. - */ - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - options: StreamMethodOptions - ): Promise>; - batchCreate( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate, - callback: BodyResponseCallback - ): void; - batchCreate( - callback: BodyResponseCallback - ): void; - batchCreate( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Batchcreate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/runs:batchCreate').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 - ); - } - } - - /** - * Creates a TensorboardRun. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.tensorboards.experiments.runs.create({ - * // Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - * tensorboardRunId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { * // "createTime": "my_createTime", * // "description": "my_description", * // "displayName": "my_displayName", * // "etag": "my_etag", - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -159923,61 +176738,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create + | 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$Tensorboards$Experiments$Runs$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; options = {}; } @@ -159990,7 +176805,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/runs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -160002,19 +176820,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a TensorboardRun. + * Deletes a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -160044,10 +176862,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.delete({ - * // Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( + * { + * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * }, + * ); * console.log(res.data); * * // Example response @@ -160073,27 +176893,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete, + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, callback: BodyResponseCallback ): void; delete( @@ -160101,7 +176920,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -160117,13 +176936,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; options = {}; } @@ -160158,7 +176977,7 @@ export namespace aiplatform_v1 { } /** - * Gets a TensorboardRun. + * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. * @example * ```js * // Before running the sample: @@ -160179,10 +176998,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -160191,21 +177007,30 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.get({ - * // Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * }); + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( + * { + * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "filter": "my_filter", + * // "orderBy": "my_orderBy", + * // "pageSize": 0, + * // "pageToken": "my_pageToken" + * // } + * }, + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "timeSeriesDataPoints": [] * // } * } * @@ -160221,62 +177046,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Get, + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + exportTensorboardTimeSeries( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get, - callback: BodyResponseCallback + exportTensorboardTimeSeries( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + exportTensorboardTimeSeries( + callback: BodyResponseCallback ): void; - get( + exportTensorboardTimeSeries( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries + | 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$Tensorboards$Experiments$Runs$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; options = {}; } @@ -160289,31 +177114,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + + '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists TensorboardRuns in a Location. + * Gets a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -160340,190 +177168,18 @@ export namespace aiplatform_v1 { * ], * }); * - * // 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 aiplatform.projects.locations.tensorboards.experiments.runs.list({ - * // Lists the TensorboardRuns that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardRuns": [] - * // } - * } - * - * 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$Tensorboards$Experiments$Runs$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/runs').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 TensorboardRun. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.projects.locations.tensorboards.experiments.runs.patch({ - * // Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "updateTime": "my_updateTime" - * // } + * // 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 aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( + * { + * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', * }, - * }); + * ); * console.log(res.data); * * // Example response @@ -160532,9 +177188,12 @@ export namespace aiplatform_v1 { * // "description": "my_description", * // "displayName": "my_displayName", * // "etag": "my_etag", - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "updateTime": "my_updateTime" + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" * // } * } * @@ -160550,62 +177209,62 @@ export namespace aiplatform_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$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get + | 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$Tensorboards$Experiments$Runs$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; options = {}; } @@ -160619,7 +177278,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -160630,19 +177289,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned. + * Lists TensorboardTimeSeries in a Location. * @example * ```js * // Before running the sample: @@ -160663,7 +177322,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -160672,24 +177334,30 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.write({ - * // Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * tensorboardRun: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "tensorboardRun": "my_tensorboardRun", - * // "timeSeriesData": [] - * // } + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( + * { + * // Lists the TensorboardTimeSeries that match the filter expression. + * filter: 'placeholder-value', + * // Field to use to sort the list. + * orderBy: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * pageSize: 'placeholder-value', + * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + * parent: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', * }, - * }); + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "tensorboardTimeSeries": [] + * // } * } * * main().catch(e => { @@ -160704,62 +177372,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions ): Promise>; - write( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - write( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$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$Tensorboards$Experiments$Runs$Write; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; options = {}; } @@ -160772,132 +177440,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardRun}:write').replace( + url: (rootUrl + '/v1/{+parent}/timeSeries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardRun'], - pathParams: ['tensorboardRun'], + 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$Tensorboards$Experiments$Runs$Batchcreate extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRuns in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` The parent field in the CreateTensorboardRunRequest messages must match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1BatchCreateTensorboardRunsRequest; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Create extends StandardParameters { - /** - * Required. The resource name of the TensorboardExperiment to create the TensorboardRun in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are `/a-z-/`. - */ - tensorboardRunId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Delete extends StandardParameters { - /** - * Required. The name of the TensorboardRun to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Get extends StandardParameters { - /** - * Required. The name of the TensorboardRun resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$List extends StandardParameters { - /** - * Lists the TensorboardRuns that match the filter expression. - */ - filter?: string; - /** - * Field to use to sort the list. - */ - orderBy?: string; - /** - * The maximum number of TensorboardRuns to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardRuns are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous TensorboardService.ListTensorboardRuns call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardRuns must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the TensorboardExperiment to list TensorboardRuns. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Patch extends StandardParameters { - /** - * Output only. Name of the TensorboardRun. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - name?: string; - /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardRun resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardRun; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Write extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to write data to. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - tensorboardRun?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1WriteTensorboardRunDataRequest; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Updates a TensorboardTimeSeries. * @example * ```js * // Before running the sample: @@ -160927,16 +177497,46 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.cancel( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // Output only. Name of the TensorboardTimeSeries. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } + * }, * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "etag": "my_etag", + * // "metadata": {}, + * // "name": "my_name", + * // "pluginData": "my_pluginData", + * // "pluginName": "my_pluginName", + * // "updateTime": "my_updateTime", + * // "valueType": "my_valueType" + * // } * } * * main().catch(e => { @@ -160951,54 +177551,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; options = {}; } @@ -161011,8 +177619,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -161023,17 +177631,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. * @example * ```js * // Before running the sample: @@ -161054,7 +177664,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -161063,16 +177676,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.delete( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // Reads the TensorboardTimeSeries' data that match the filter expression. + * filter: 'placeholder-value', + * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + * maxDataPoints: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * tensorboardTimeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', * }, * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "timeSeriesData": {} + * // } * } * * main().catch(e => { @@ -161087,54 +177707,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Operations$Delete, + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + read( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete, - callback: BodyResponseCallback + read( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + read( + callback: BodyResponseCallback + ): void; + read( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; options = {}; } @@ -161147,29 +177775,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['tensorboardTimeSeries'], + pathParams: ['tensorboardTimeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. * @example * ```js * // Before running the sample: @@ -161190,7 +177823,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -161199,21 +177835,20 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.get( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', + * // IDs of the blobs to read. + * blobIds: 'placeholder-value', + * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * timeSeries: + * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', * }, * ); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "blobs": [] * // } * } * @@ -161229,58 +177864,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Operations$Get, + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + readBlobData( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + ): Promise< + GaxiosResponseWithHTTP2 + >; + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get, - callback: BodyResponseCallback + readBlobData( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + readBlobData( + callback: BodyResponseCallback ): void; - get( + readBlobData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; options = {}; } @@ -161293,29 +177932,145 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['timeSeries'], + pathParams: ['timeSeries'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + parent?: string; + /** + * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" + */ + tensorboardTimeSeriesId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete extends StandardParameters { + /** + * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries extends StandardParameters { + /** + * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + tensorboardTimeSeries?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get extends StandardParameters { + /** + * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List extends StandardParameters { + /** + * Lists the TensorboardTimeSeries that match the filter expression. + */ + filter?: string; + /** + * Field to use to sort the list. + */ + orderBy?: string; + /** + * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch extends StandardParameters { + /** + * Output only. Name of the TensorboardTimeSeries. + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read extends StandardParameters { + /** + * Reads the TensorboardTimeSeries' data that match the filter expression. + */ + filter?: string; + /** + * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. + */ + maxDataPoints?: number; + /** + * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + tensorboardTimeSeries?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata extends StandardParameters { + /** + * IDs of the blobs to read. + */ + blobIds?: string[]; + /** + * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + */ + timeSeries?: string; + } + + export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -161345,28 +178100,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.list( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] - * // } + * // {} * } * * main().catch(e => { @@ -161381,62 +178124,54 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Operations$List, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; options = {}; } @@ -161449,11 +178184,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -161464,19 +178196,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -161506,24 +178236,16 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.operations.wait( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -161538,58 +178260,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + callback: BodyResponseCallback ): void; - wait( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; options = {}; } @@ -161602,8 +178320,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -161614,80 +178332,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries { - context: APIRequestContext; - operations: Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations( - this.context - ); - } /** - * Creates a TensorboardTimeSeries. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -161717,46 +178372,21 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.create( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( * { - * // Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - * tensorboardTimeSeriesId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', * }, * ); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "response": {} * // } * } * @@ -161772,62 +178402,57 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; options = {}; } @@ -161840,34 +178465,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a TensorboardTimeSeries. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -161897,21 +178517,27 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.delete( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( * { - * // Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // Example response + * // { + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -161927,58 +178553,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; options = {}; } @@ -161991,8 +178621,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -162003,17 +178636,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Exports a TensorboardTimeSeries' data. Data is returned in paginated responses. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -162043,30 +178678,23 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.exportTensorboardTimeSeries( + * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( * { - * // Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filter": "my_filter", - * // "orderBy": "my_orderBy", - * // "pageSize": 0, - * // "pageToken": "my_pageToken" - * // } - * }, + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }, * ); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "timeSeriesDataPoints": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -162082,62 +178710,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions ): Promise>; - exportTensorboardTimeSeries( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - exportTensorboardTimeSeries( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries; + {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; options = {}; } @@ -162150,34 +178773,87 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1/{+tensorboardTimeSeries}:exportTensorboardTimeSeries' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel extends StandardParameters { /** - * Gets a TensorboardTimeSeries. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Tensorboards$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -162198,10 +178874,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -162210,27 +178883,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.get( - * { - * // Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } + * // {} * } * * main().catch(e => { @@ -162245,62 +178905,54 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Get, + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + cancel( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, + ): Promise>; + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; options = {}; } @@ -162313,8 +178965,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -162325,19 +178977,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists TensorboardTimeSeries in a Location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -162358,10 +179008,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -162370,30 +179017,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.list( - * { - * // Lists the TensorboardTimeSeries that match the filter expression. - * filter: 'placeholder-value', - * // Field to use to sort the list. - * orderBy: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - * pageSize: 'placeholder-value', - * // A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - * parent: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', - * }, - * ); + * await aiplatform.projects.locations.tensorboards.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "tensorboardTimeSeries": [] - * // } + * // {} * } * * main().catch(e => { @@ -162408,62 +179039,54 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$List, + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + delete( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; options = {}; } @@ -162476,34 +179099,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/timeSeries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TensorboardTimeSeries. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -162532,46 +179150,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.patch( - * { - * // Output only. Name of the TensorboardTimeSeries. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", - * // "metadata": {}, - * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" - * // } - * }, - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "etag": "my_etag", + * // "done": false, + * // "error": {}, * // "metadata": {}, * // "name": "my_name", - * // "pluginData": "my_pluginData", - * // "pluginName": "my_pluginName", - * // "updateTime": "my_updateTime", - * // "valueType": "my_valueType" + * // "response": {} * // } * } * @@ -162587,62 +179178,57 @@ export namespace aiplatform_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$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; options = {}; } @@ -162656,7 +179242,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -162667,19 +179253,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Reads a TensorboardTimeSeries' data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can't be greater than 10k. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -162700,10 +179284,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -162711,23 +179292,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.read( - * { - * // Reads the TensorboardTimeSeries' data that match the filter expression. - * filter: 'placeholder-value', - * // The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - * maxDataPoints: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * tensorboardTimeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "timeSeriesData": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -162743,62 +179326,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions ): Promise>; - read( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - read( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + callback: BodyResponseCallback ): void; - read( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - read( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$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$Tensorboards$Experiments$Runs$Timeseries$Read; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; options = {}; } @@ -162811,7 +179394,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+tensorboardTimeSeries}:read').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -162821,24 +179404,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['tensorboardTimeSeries'], - pathParams: ['tensorboardTimeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets bytes of TensorboardBlobs. This is to allow reading blob data stored in consumer project's Cloud Storage bucket without users having to obtain Cloud Storage access permission. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -162859,10 +179442,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -162870,21 +179450,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.readBlobData( - * { - * // IDs of the blobs to read. - * blobIds: 'placeholder-value', - * // Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - * timeSeries: - * 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * }, - * ); + * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "blobs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -162900,62 +179480,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions ): Promise>; - readBlobData( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + ): Promise>; + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - readBlobData( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata, - callback: BodyResponseCallback + wait( + params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + callback: BodyResponseCallback ): void; - readBlobData( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - readBlobData( + wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata; + {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; options = {}; } @@ -162968,145 +179543,92 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+timeSeries}:readBlobData').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['timeSeries'], - pathParams: ['timeSeries'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Create extends StandardParameters { - /** - * Required. The resource name of the TensorboardRun to create the TensorboardTimeSeries in. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Optional. The user specified unique ID to use for the TensorboardTimeSeries, which becomes the final component of the TensorboardTimeSeries's resource name. This value should match "a-z0-9{0, 127\}" - */ - tensorboardTimeSeriesId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel extends StandardParameters { /** - * Required. The name of the TensorboardTimeSeries to be deleted. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Exporttensorboardtimeseries extends StandardParameters { - /** - * Required. The resource name of the TensorboardTimeSeries to export data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - tensorboardTimeSeries?: string; - + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1ExportTensorboardTimeSeriesDataRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get extends StandardParameters { /** - * Required. The name of the TensorboardTimeSeries resource. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List extends StandardParameters { /** - * Lists the TensorboardTimeSeries that match the filter expression. + * The standard list filter. */ filter?: string; /** - * Field to use to sort the list. + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * The maximum number of TensorboardTimeSeries to return. The service may return fewer than this value. If unspecified, at most 50 TensorboardTimeSeries are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous TensorboardService.ListTensorboardTimeSeries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to TensorboardService.ListTensorboardTimeSeries must match the call that provided the page token. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the TensorboardRun to list TensorboardTimeSeries. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - readMask?: string; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Patch extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait extends StandardParameters { /** - * Output only. Name of the TensorboardTimeSeries. + * The name of the operation resource to wait on. */ name?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the TensorboardTimeSeries resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it's in the mask. If the user does not provide a mask then all fields are overwritten if new values are specified. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1TensorboardTimeSeries; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Read extends StandardParameters { - /** - * Reads the TensorboardTimeSeries' data that match the filter expression. - */ - filter?: string; - /** - * The maximum number of TensorboardTimeSeries' data to return. This value should be a positive integer. This value can be set to -1 to return all data. - */ - maxDataPoints?: number; - /** - * Required. The resource name of the TensorboardTimeSeries to read data from. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` - */ - tensorboardTimeSeries?: string; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Readblobdata extends StandardParameters { - /** - * IDs of the blobs to read. - */ - blobIds?: string[]; - /** - * Required. The resource name of the TensorboardTimeSeries to list Blobs. Format: `projects/{project\}/locations/{location\}/tensorboards/{tensorboard\}/experiments/{experiment\}/runs/{run\}/timeSeries/{time_series\}` + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - timeSeries?: string; + timeout?: string; } - export class Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations { + export class Resource$Projects$Locations$Trainingpipelines { context: APIRequestContext; + operations: Resource$Projects$Locations$Trainingpipelines$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Trainingpipelines$Operations( + this.context + ); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. * @example * ```js * // Before running the sample: @@ -163135,13 +179657,16 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ + * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, + * }); * console.log(res.data); * * // Example response @@ -163161,31 +179686,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel + | Params$Resource$Projects$Locations$Trainingpipelines$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163201,13 +179726,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; options = {}; } @@ -163242,7 +179767,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. * @example * ```js * // Before running the sample: @@ -163271,17 +179796,56 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.trainingPipelines.create({ + * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -163296,54 +179860,62 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + create( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; options = {}; } @@ -163356,29 +179928,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Deletes a TrainingPipeline. * @example * ```js * // Before running the sample: @@ -163407,13 +179984,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.get( - * { - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * }, - * ); + * const res = await aiplatform.projects.locations.trainingPipelines.delete({ + * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * }); * console.log(res.data); * * // Example response @@ -163438,36 +180012,35 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get + | Params$Resource$Projects$Locations$Trainingpipelines$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163483,13 +180056,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; options = {}; } @@ -163503,7 +180076,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -163524,7 +180097,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a TrainingPipeline. * @example * ```js * // Before running the sample: @@ -163553,28 +180126,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.list( - * { - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.trainingPipelines.get({ + * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "inputDataConfig": {}, + * // "labels": {}, + * // "modelId": "my_modelId", + * // "modelToUpload": {}, + * // "name": "my_name", + * // "parentModel": "my_parentModel", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "trainingTaskDefinition": "my_trainingTaskDefinition", + * // "trainingTaskInputs": {}, + * // "trainingTaskMetadata": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -163590,62 +180166,61 @@ export namespace aiplatform_v1 { * @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$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$Get + | 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$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List; + params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; options = {}; } @@ -163658,10 +180233,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -163673,19 +180245,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Lists TrainingPipelines in a Location. * @example * ```js * // Before running the sample: @@ -163714,24 +180286,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.tensorboards.experiments.runs.timeSeries.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/experiments/my-experiment/runs/my-run/timeSeries/my-timeSerie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.projects.locations.trainingPipelines.list({ + * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * filter: 'placeholder-value', + * // The standard list page size. + * pageSize: 'placeholder-value', + * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', + * // Mask specifying which fields to read. + * readMask: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "trainingPipelines": [] * // } * } * @@ -163747,58 +180319,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + list( + params?: Params$Resource$Projects$Locations$Trainingpipelines$List, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Trainingpipelines$List, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - wait( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait - | BodyResponseCallback + | Params$Resource$Projects$Locations$Trainingpipelines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait; + {} as Params$Resource$Projects$Locations$Trainingpipelines$List; options = {}; } @@ -163811,80 +180387,91 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Get extends StandardParameters { /** - * The standard list filter. + * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Trainingpipelines$List extends StandardParameters { /** - * The name of the operation's parent resource. + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` */ - name?: string; + filter?: string; /** * The standard list page size. */ pageSize?: number; /** - * The standard list page token. + * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. */ 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Projects$Locations$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. + * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Mask specifying which fields to read. */ - timeout?: string; + readMask?: string; } - export class Resource$Projects$Locations$Tensorboards$Operations { + export class Resource$Projects$Locations$Trainingpipelines$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -163921,9 +180508,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.operations.cancel({ + * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * @@ -163944,31 +180531,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -163984,13 +180571,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; options = {}; } @@ -164055,9 +180642,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.projects.locations.tensorboards.operations.delete({ + * await aiplatform.projects.locations.trainingPipelines.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', * }); * console.log(res.data); * @@ -164078,31 +180665,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Delete, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Delete + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164118,13 +180705,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Delete; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; options = {}; } @@ -164188,10 +180775,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -164217,27 +180805,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Get, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -164245,7 +180832,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Get + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164261,13 +180848,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Get; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; options = {}; } @@ -164331,18 +180918,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -164366,29 +180954,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$List, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, callback: BodyResponseCallback ): void; list( @@ -164396,7 +180984,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$List + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164414,13 +181002,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$List; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; options = {}; } @@ -164489,12 +181077,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tensorboards.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/tensorboards/my-tensorboard/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = + * await aiplatform.projects.locations.trainingPipelines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -164520,27 +181109,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Tensorboards$Operations$Wait, + params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -164548,7 +181136,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tensorboards$Operations$Wait + | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164564,13 +181152,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Tensorboards$Operations$Wait; + {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; options = {}; } @@ -164605,25 +181193,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -164645,7 +181233,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Tensorboards$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -164656,19 +181244,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Trainingpipelines { + export class Resource$Projects$Locations$Tuningjobs { context: APIRequestContext; - operations: Resource$Projects$Locations$Trainingpipelines$Operations; + operations: Resource$Projects$Locations$Tuningjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Trainingpipelines$Operations( - this.context - ); + this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( + this.context + ); } /** - * Cancels a TrainingPipeline. Starts asynchronous cancellation on the TrainingPipeline. The server makes a best effort to cancel the pipeline, but success is not guaranteed. Clients can use PipelineService.GetTrainingPipeline or other methods to check whether the cancellation succeeded or whether the pipeline completed despite cancellation. On successful cancellation, the TrainingPipeline is not deleted; instead it becomes a pipeline with a TrainingPipeline.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`, and TrainingPipeline.state is set to `CANCELLED`. + * Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -164697,9 +181284,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.cancel({ - * // Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.projects.locations.tuningJobs.cancel({ + * // Required. The name of the tuning job to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', * * // Request body metadata * requestBody: { @@ -164726,31 +181313,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params?: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Cancel + | Params$Resource$Projects$Locations$Tuningjobs$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -164766,13 +181353,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Cancel; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Cancel; options = {}; } @@ -164807,7 +181393,7 @@ export namespace aiplatform_v1 { } /** - * Creates a TrainingPipeline. A created TrainingPipeline right away will be attempted to be run. + * Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process. * @example * ```js * // Before running the sample: @@ -164836,30 +181422,33 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.create({ - * // Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.tuningJobs.create({ + * // Required. The resource name of the location to create the tuning job in. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "baseModel": "my_baseModel", * // "createTime": "my_createTime", - * // "displayName": "my_displayName", + * // "description": "my_description", * // "encryptionSpec": {}, * // "endTime": "my_endTime", * // "error": {}, - * // "inputDataConfig": {}, + * // "evaluateDatasetRuns": [], + * // "experiment": "my_experiment", * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, * // "name": "my_name", - * // "parentModel": "my_parentModel", + * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, + * // "serviceAccount": "my_serviceAccount", * // "startTime": "my_startTime", * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, * // "updateTime": "my_updateTime" * // } * }, @@ -164868,22 +181457,25 @@ export namespace aiplatform_v1 { * * // Example response * // { + * // "baseModel": "my_baseModel", * // "createTime": "my_createTime", - * // "displayName": "my_displayName", + * // "description": "my_description", * // "encryptionSpec": {}, * // "endTime": "my_endTime", * // "error": {}, - * // "inputDataConfig": {}, + * // "evaluateDatasetRuns": [], + * // "experiment": "my_experiment", * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, * // "name": "my_name", - * // "parentModel": "my_parentModel", + * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, + * // "serviceAccount": "my_serviceAccount", * // "startTime": "my_startTime", * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, * // "updateTime": "my_updateTime" * // } * } @@ -164901,61 +181493,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Create, + params?: Params$Resource$Projects$Locations$Tuningjobs$Create, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, + params: Params$Resource$Projects$Locations$Tuningjobs$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Trainingpipelines$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Tuningjobs$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Create + | 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$Trainingpipelines$Create; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Create; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Create; options = {}; } @@ -164968,7 +181559,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( + url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -164983,19 +181574,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a TrainingPipeline. + * Gets a tuning job. * @example * ```js * // Before running the sample: @@ -165024,19 +181615,34 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.delete({ - * // Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.projects.locations.tuningJobs.get({ + * // Required. The name of the tuning job to retrieve. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', * }); * console.log(res.data); * * // Example response * // { - * // "done": false, + * // "baseModel": "my_baseModel", + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "encryptionSpec": {}, + * // "endTime": "my_endTime", * // "error": {}, - * // "metadata": {}, + * // "evaluateDatasetRuns": [], + * // "experiment": "my_experiment", + * // "labels": {}, * // "name": "my_name", - * // "response": {} + * // "preTunedModel": {}, + * // "preferenceOptimizationSpec": {}, + * // "serviceAccount": "my_serviceAccount", + * // "startTime": "my_startTime", + * // "state": "my_state", + * // "supervisedTuningSpec": {}, + * // "tunedModel": {}, + * // "tunedModelDisplayName": "my_tunedModelDisplayName", + * // "tuningDataStats": {}, + * // "updateTime": "my_updateTime" * // } * } * @@ -165052,58 +181658,61 @@ export namespace aiplatform_v1 { * @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$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params?: Params$Resource$Projects$Locations$Tuningjobs$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Tuningjobs$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Delete; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$Get; options = {}; } @@ -165117,7 +181726,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -165128,17 +181737,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a TrainingPipeline. + * Lists tuning jobs in a location. * @example * ```js * // Before running the sample: @@ -165167,31 +181778,22 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.get({ - * // Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', + * const res = await aiplatform.projects.locations.tuningJobs.list({ + * // Optional. The standard list filter. + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call. + * pageToken: 'placeholder-value', + * // Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project\}/locations/{location\}` + * parent: 'projects/my-project/locations/my-location', * }); * console.log(res.data); * * // Example response * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "inputDataConfig": {}, - * // "labels": {}, - * // "modelId": "my_modelId", - * // "modelToUpload": {}, - * // "name": "my_name", - * // "parentModel": "my_parentModel", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "trainingTaskDefinition": "my_trainingTaskDefinition", - * // "trainingTaskInputs": {}, - * // "trainingTaskMetadata": {}, - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "tuningJobs": [] * // } * } * @@ -165207,61 +181809,61 @@ export namespace aiplatform_v1 { * @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$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params?: Params$Resource$Projects$Locations$Tuningjobs$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Tuningjobs$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$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$Trainingpipelines$Get; + {}) as Params$Resource$Projects$Locations$Tuningjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Trainingpipelines$Get; + params = {} as Params$Resource$Projects$Locations$Tuningjobs$List; options = {}; } @@ -165274,31 +181876,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, 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 ); } } /** - * Lists TrainingPipelines in a Location. + * Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model. * @example * ```js * // Before running the sample: @@ -165327,24 +181932,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.trainingPipelines.list({ - * // The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` - * filter: 'placeholder-value', - * // The standard list page size. - * pageSize: 'placeholder-value', - * // The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * const res = await aiplatform.projects.locations.tuningJobs.rebaseTunedModel({ + * // Required. The resource name of the location in which to rebase the Model. Format: `projects/{project\}/locations/{location\}` * parent: 'projects/my-project/locations/my-location', - * // Mask specifying which fields to read. - * readMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "artifactDestination": {}, + * // "deployToSameEndpoint": false, + * // "tunedModelRef": {}, + * // "tuningJob": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "trainingPipelines": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -165360,62 +181971,57 @@ export namespace aiplatform_v1 { * @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$Trainingpipelines$List, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Trainingpipelines$List, + rebaseTunedModel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + ): Promise>; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Trainingpipelines$List, - callback: BodyResponseCallback + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + rebaseTunedModel( + callback: BodyResponseCallback ): void; - list( + rebaseTunedModel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$List; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$List; + {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; options = {}; } @@ -165428,11 +182034,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/trainingPipelines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1/{+parent}/tuningJobs:rebaseTunedModel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -165443,76 +182048,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Cancel extends StandardParameters { /** - * Required. The name of the TrainingPipeline to cancel. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * Required. The name of the tuning job to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelTrainingPipelineRequest; + requestBody?: Schema$GoogleCloudAiplatformV1CancelTuningJobRequest; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Create extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Create extends StandardParameters { /** - * Required. The resource name of the Location to create the TrainingPipeline in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the location to create the tuning job in. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TrainingPipeline; - } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Delete extends StandardParameters { - /** - * Required. The name of the TrainingPipeline resource to be deleted. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudAiplatformV1TuningJob; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Get extends StandardParameters { /** - * Required. The name of the TrainingPipeline resource. Format: `projects/{project\}/locations/{location\}/trainingPipelines/{training_pipeline\}` + * Required. The name of the tuning job to retrieve. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$List extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `training_task_definition` `=`, `!=` comparisons, and `:` wildcard. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="PIPELINE_STATE_SUCCEEDED" AND display_name:"my_pipeline_*"` * `state!="PIPELINE_STATE_FAILED" OR display_name="my_pipeline"` * `NOT display_name="my_pipeline"` * `create_time\>"2021-05-18T00:00:00Z"` * `training_task_definition:"*automl_text_classification*"` + * Optional. The standard list filter. */ filter?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListTrainingPipelinesResponse.next_page_token of the previous PipelineService.ListTrainingPipelines call. + * Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call. */ pageToken?: string; /** - * Required. The resource name of the Location to list the TrainingPipelines from. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project\}/locations/{location\}` */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel extends StandardParameters { /** - * Mask specifying which fields to read. + * Required. The resource name of the location in which to rebase the Model. Format: `projects/{project\}/locations/{location\}` */ - readMask?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest; } - export class Resource$Projects$Locations$Trainingpipelines$Operations { + export class Resource$Projects$Locations$Tuningjobs$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -165548,11 +182152,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -165572,31 +182175,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -165612,13 +182215,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; options = {}; } @@ -165682,11 +182285,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -165706,31 +182308,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -165746,13 +182348,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; options = {}; } @@ -165816,11 +182418,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.get({ - * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.get({ + * // The name of the operation resource. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -165846,27 +182447,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -165874,7 +182474,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -165890,13 +182490,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; options = {}; } @@ -165960,19 +182560,18 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 @@ -165996,29 +182595,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$List, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, callback: BodyResponseCallback ): void; list( @@ -166026,7 +182625,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$List + | Params$Resource$Projects$Locations$Tuningjobs$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166044,13 +182643,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$List; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; options = {}; } @@ -166119,13 +182718,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.projects.locations.trainingPipelines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'projects/my-project/locations/my-location/trainingPipelines/my-trainingPipeline/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }); + * const res = await aiplatform.projects.locations.tuningJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -166151,27 +182749,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait, + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -166179,7 +182776,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -166195,13 +182792,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait; + {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait; options = {}; } @@ -166236,25 +182833,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Delete extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Get extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$List extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -166276,7 +182873,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Projects$Locations$Trainingpipelines$Operations$Wait extends StandardParameters { + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -166287,18 +182884,23 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Projects$Locations$Tuningjobs { + export class Resource$Publishers { + context: APIRequestContext; + models: Resource$Publishers$Models; + constructor(context: APIRequestContext) { + this.context = context; + this.models = new Resource$Publishers$Models(this.context); + } + } + + export class Resource$Publishers$Models { context: APIRequestContext; - operations: Resource$Projects$Locations$Tuningjobs$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( - this.context - ); } /** - * Cancels a tuning job. Starts an asynchronous cancellation request. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use GenAiTuningService.GetTuningJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the tuning job is not deleted. Instead, its state is set to `CANCELLED`, and `error` is set to a status with a `google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. + * Return a list of tokens based on the input text. * @example * ```js * // Before running the sample: @@ -166327,20 +182929,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.cancel({ - * // Required. The name of the tuning job to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * const res = await aiplatform.publishers.models.computeTokens({ + * // Required. The name of the Endpoint requested to get lists of tokens and token ids. + * endpoint: 'publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters - * // {} + * // { + * // "contents": [], + * // "instances": [], + * // "model": "my_model" + * // } * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "tokensInfo": [] + * // } * } * * main().catch(e => { @@ -166355,53 +182963,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + computeTokens( + params?: Params$Resource$Publishers$Models$Computetokens, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Cancel, - callback: BodyResponseCallback + computeTokens( + params: Params$Resource$Publishers$Models$Computetokens, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + computeTokens( + callback: BodyResponseCallback + ): void; + computeTokens( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Cancel - | BodyResponseCallback + | Params$Resource$Publishers$Models$Computetokens + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Cancel; + {}) as Params$Resource$Publishers$Models$Computetokens; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Cancel; + params = {} as Params$Resource$Publishers$Models$Computetokens; options = {}; } @@ -166414,29 +183030,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a tuning job. A created tuning job will be subsequently executed to start the model tuning process. + * Perform a token counting. * @example * ```js * // Before running the sample: @@ -166465,34 +183086,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.create({ - * // Required. The resource name of the location to create the tuning job in. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.publishers.models.countTokens({ + * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "evaluateDatasetRuns": [], - * // "experiment": "my_experiment", - * // "labels": {}, - * // "name": "my_name", - * // "preTunedModel": {}, - * // "preferenceOptimizationSpec": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" + * // "contents": [], + * // "generationConfig": {}, + * // "instances": [], + * // "model": "my_model", + * // "systemInstruction": {}, + * // "tools": [] * // } * }, * }); @@ -166500,26 +183107,171 @@ export namespace aiplatform_v1 { * * // Example response * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", + * // "promptTokensDetails": [], + * // "totalBillableCharacters": 0, + * // "totalTokens": 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. + */ + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: StreamMethodOptions + ): Promise>; + countTokens( + params?: Params$Resource$Publishers$Models$Counttokens, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + countTokens( + params: Params$Resource$Publishers$Models$Counttokens, + callback: BodyResponseCallback + ): void; + countTokens( + callback: BodyResponseCallback + ): void; + countTokens( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Counttokens + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Counttokens; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Counttokens; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Fetch an asynchronous online prediction operation. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.publishers.models.fetchPredictOperation({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, * // "error": {}, - * // "evaluateDatasetRuns": [], - * // "experiment": "my_experiment", - * // "labels": {}, + * // "metadata": {}, * // "name": "my_name", - * // "preTunedModel": {}, - * // "preferenceOptimizationSpec": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" + * // "response": {} * // } * } * @@ -166535,61 +183287,225 @@ export namespace aiplatform_v1 { * @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$Tuningjobs$Create, + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Projects$Locations$Tuningjobs$Create, + fetchPredictOperation( + params?: Params$Resource$Publishers$Models$Fetchpredictoperation, + options?: MethodOptions + ): Promise>; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + params: Params$Resource$Publishers$Models$Fetchpredictoperation, + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + callback: BodyResponseCallback + ): void; + fetchPredictOperation( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Fetchpredictoperation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generate content with multimodal inputs. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.publishers.models.generateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * 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. + */ + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + options: StreamMethodOptions + ): Promise>; + generateContent( + params?: Params$Resource$Publishers$Models$Generatecontent, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Tuningjobs$Create, - callback: BodyResponseCallback + generateContent( + params: Params$Resource$Publishers$Models$Generatecontent, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + generateContent( + callback: BodyResponseCallback ): void; - create( + generateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Create - | BodyResponseCallback + | Params$Resource$Publishers$Models$Generatecontent + | 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$Tuningjobs$Create; + {}) as Params$Resource$Publishers$Models$Generatecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Create; + params = {} as Params$Resource$Publishers$Models$Generatecontent; options = {}; } @@ -166602,7 +183518,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( + url: (rootUrl + '/v1/{+model}:generateContent').replace( /([^:]\/)\/+/g, '$1' ), @@ -166612,24 +183528,24 @@ export namespace aiplatform_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a tuning job. + * Gets a Model Garden publisher model. * @example * ```js * // Before running the sample: @@ -166658,34 +183574,31 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.get({ - * // Required. The name of the tuning job to retrieve. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * const res = await aiplatform.publishers.models.get({ + * // Optional. Token used to access Hugging Face gated models. + * huggingFaceToken: 'placeholder-value', + * // Optional. Boolean indicates whether the requested model is a Hugging Face model. + * isHuggingFaceModel: 'placeholder-value', + * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + * languageCode: 'placeholder-value', + * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + * name: 'publishers/my-publisher/models/my-model', + * // Optional. PublisherModel view specifying which fields to read. + * view: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "baseModel": "my_baseModel", - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "encryptionSpec": {}, - * // "endTime": "my_endTime", - * // "error": {}, - * // "evaluateDatasetRuns": [], - * // "experiment": "my_experiment", - * // "labels": {}, + * // "frameworks": [], + * // "launchStage": "my_launchStage", * // "name": "my_name", - * // "preTunedModel": {}, - * // "preferenceOptimizationSpec": {}, - * // "serviceAccount": "my_serviceAccount", - * // "startTime": "my_startTime", - * // "state": "my_state", - * // "supervisedTuningSpec": {}, - * // "tunedModel": {}, - * // "tunedModelDisplayName": "my_tunedModelDisplayName", - * // "tuningDataStats": {}, - * // "updateTime": "my_updateTime" + * // "openSourceCategory": "my_openSourceCategory", + * // "predictSchemata": {}, + * // "publisherModelTemplate": "my_publisherModelTemplate", + * // "supportedActions": {}, + * // "versionId": "my_versionId", + * // "versionState": "my_versionState" * // } * } * @@ -166702,60 +183615,60 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Publishers$Models$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tuningjobs$Get, + params?: Params$Resource$Publishers$Models$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Publishers$Models$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, + params: Params$Resource$Publishers$Models$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Get, - callback: BodyResponseCallback + params: Params$Resource$Publishers$Models$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Get - | BodyResponseCallback + | Params$Resource$Publishers$Models$Get + | 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$Tuningjobs$Get; + {}) as Params$Resource$Publishers$Models$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$Get; + params = {} as Params$Resource$Publishers$Models$Get; options = {}; } @@ -166780,19 +183693,18 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists tuning jobs in a location. * @example * ```js * // Before running the sample: @@ -166813,7 +183725,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -166821,22 +183736,30 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.list({ - * // Optional. The standard list filter. - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call. - * pageToken: 'placeholder-value', - * // Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.publishers.models.predict({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * endpoint: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "instances": [], + * // "labels": {}, + * // "parameters": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "tuningJobs": [] + * // "deployedModelId": "my_deployedModelId", + * // "metadata": {}, + * // "model": "my_model", + * // "modelDisplayName": "my_modelDisplayName", + * // "modelVersionId": "my_modelVersionId", + * // "predictions": [] * // } * } * @@ -166852,61 +183775,61 @@ export namespace aiplatform_v1 { * @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$Tuningjobs$List, + predict( + params: Params$Resource$Publishers$Models$Predict, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Projects$Locations$Tuningjobs$List, + predict( + params?: Params$Resource$Publishers$Models$Predict, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, + predict( + params: Params$Resource$Publishers$Models$Predict, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, + predict( + params: Params$Resource$Publishers$Models$Predict, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Tuningjobs$List, - callback: BodyResponseCallback + predict( + params: Params$Resource$Publishers$Models$Predict, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + predict( + callback: BodyResponseCallback ): void; - list( + predict( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$List - | BodyResponseCallback + | Params$Resource$Publishers$Models$Predict + | 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$Tuningjobs$List; + {}) as Params$Resource$Publishers$Models$Predict; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Tuningjobs$List; + params = {} as Params$Resource$Publishers$Models$Predict; options = {}; } @@ -166919,34 +183842,33 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tuningJobs').replace( + url: (rootUrl + '/v1/{+endpoint}:predict').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['endpoint'], + pathParams: ['endpoint'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Rebase a tuned model. A rebase operation takes a model that was previously tuned on a base model version, and retunes it on a new base model version. The rebase operation creates a new tuning job and a new tuned model. * @example * ```js * // Before running the sample: @@ -166967,7 +183889,10 @@ export namespace aiplatform_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'], + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/cloud-platform.read-only', + * ], * }); * * // Acquire an auth client, and bind it to all future calls @@ -166975,18 +183900,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.rebaseTunedModel({ - * // Required. The resource name of the location in which to rebase the Model. Format: `projects/{project\}/locations/{location\}` - * parent: 'projects/my-project/locations/my-location', + * const res = await aiplatform.publishers.models.predictLongRunning({ + * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * endpoint: 'publishers/my-publisher/models/my-model', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "artifactDestination": {}, - * // "deployToSameEndpoint": false, - * // "tunedModelRef": {}, - * // "tuningJob": {} + * // "instances": [], + * // "labels": {}, + * // "parameters": {} * // } * }, * }); @@ -167014,58 +183938,225 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: StreamMethodOptions ): Promise>; - rebaseTunedModel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + predictLongRunning( + params?: Params$Resource$Publishers$Models$Predictlongrunning, options?: MethodOptions ): Promise>; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rebaseTunedModel( - params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + predictLongRunning( + params: Params$Resource$Publishers$Models$Predictlongrunning, callback: BodyResponseCallback ): void; - rebaseTunedModel( + predictLongRunning( callback: BodyResponseCallback ): void; - rebaseTunedModel( + predictLongRunning( + paramsOrCallback?: + | Params$Resource$Publishers$Models$Predictlongrunning + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$Predictlongrunning; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$Predictlongrunning; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['endpoint'], + pathParams: ['endpoint'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generate content with multimodal inputs with streaming support. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', + * ], + * }); + * + * // 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 aiplatform.publishers.models.streamGenerateContent({ + * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * model: 'publishers/my-publisher/models/my-model', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "cachedContent": "my_cachedContent", + * // "contents": [], + * // "generationConfig": {}, + * // "labels": {}, + * // "modelArmorConfig": {}, + * // "safetySettings": [], + * // "systemInstruction": {}, + * // "toolConfig": {}, + * // "tools": [] + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "candidates": [], + * // "createTime": "my_createTime", + * // "modelVersion": "my_modelVersion", + * // "promptFeedback": {}, + * // "responseId": "my_responseId", + * // "usageMetadata": {} + * // } + * } + * + * 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. + */ + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: StreamMethodOptions + ): Promise>; + streamGenerateContent( + params?: Params$Resource$Publishers$Models$Streamgeneratecontent, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + params: Params$Resource$Publishers$Models$Streamgeneratecontent, + callback: BodyResponseCallback + ): void; + streamGenerateContent( + callback: BodyResponseCallback + ): void; + streamGenerateContent( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel - | BodyResponseCallback + | Params$Resource$Publishers$Models$Streamgeneratecontent + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; options = {}; } @@ -167078,89 +184169,145 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/tuningJobs:rebaseTunedModel' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['model'], + pathParams: ['model'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Tuningjobs$Cancel extends StandardParameters { + export interface Params$Resource$Publishers$Models$Computetokens extends StandardParameters { /** - * Required. The name of the tuning job to cancel. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * Required. The name of the Endpoint requested to get lists of tokens and token ids. */ - name?: string; + endpoint?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelTuningJobRequest; + requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Create extends StandardParameters { + export interface Params$Resource$Publishers$Models$Counttokens extends StandardParameters { /** - * Required. The resource name of the location to create the tuning job in. Format: `projects/{project\}/locations/{location\}` + * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - parent?: string; + endpoint?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1TuningJob; + requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Get extends StandardParameters { + export interface Params$Resource$Publishers$Models$Fetchpredictoperation extends StandardParameters { /** - * Required. The name of the tuning job to retrieve. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + */ + endpoint?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + } + export interface Params$Resource$Publishers$Models$Generatecontent extends StandardParameters { + /** + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + */ + model?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + } + export interface Params$Resource$Publishers$Models$Get extends StandardParameters { + /** + * Optional. Token used to access Hugging Face gated models. + */ + huggingFaceToken?: string; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face model. + */ + isHuggingFaceModel?: boolean; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + */ + languageCode?: string; + /** + * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` */ name?: string; + /** + * Optional. PublisherModel view specifying which fields to read. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Tuningjobs$List extends StandardParameters { + export interface Params$Resource$Publishers$Models$Predict extends StandardParameters { /** - * Optional. The standard list filter. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - filter?: string; + endpoint?: string; + /** - * Optional. The standard list page size. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; + } + export interface Params$Resource$Publishers$Models$Predictlongrunning extends StandardParameters { /** - * Optional. The standard list page token. Typically obtained from ListTuningJobsResponse.next_page_token of the previous GenAiTuningService.ListTuningJobs call. + * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` */ - pageToken?: string; + endpoint?: string; + /** - * Required. The resource name of the location to list the tuning jobs from. Format: `projects/{project\}/locations/{location\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; } - export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel extends StandardParameters { + export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { /** - * Required. The resource name of the location in which to rebase the Model. Format: `projects/{project\}/locations/{location\}` + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ - parent?: string; + model?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest; + requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; } - export class Resource$Projects$Locations$Tuningjobs$Operations { + export class Resource$Ragcorpora { + context: APIRequestContext; + operations: Resource$Ragcorpora$Operations; + ragFiles: Resource$Ragcorpora$Ragfiles; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Operations(this.context); + this.ragFiles = new Resource$Ragcorpora$Ragfiles(this.context); + } + } + + export class Resource$Ragcorpora$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -167196,9 +184343,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.cancel({ + * const res = await aiplatform.ragCorpora.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * name: 'ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * @@ -167219,31 +184366,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Ragcorpora$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params?: Params$Resource$Ragcorpora$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Ragcorpora$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Ragcorpora$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel, + params: Params$Resource$Ragcorpora$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel + | Params$Resource$Ragcorpora$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -167259,13 +184406,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + {}) as Params$Resource$Ragcorpora$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel; + params = {} as Params$Resource$Ragcorpora$Operations$Cancel; options = {}; } @@ -167329,9 +184475,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.delete({ + * const res = await aiplatform.ragCorpora.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * name: 'ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * @@ -167352,31 +184498,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Ragcorpora$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params?: Params$Resource$Ragcorpora$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Ragcorpora$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Ragcorpora$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + params: Params$Resource$Ragcorpora$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + | Params$Resource$Ragcorpora$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -167392,13 +184538,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + {}) as Params$Resource$Ragcorpora$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + params = {} as Params$Resource$Ragcorpora$Operations$Delete; options = {}; } @@ -167462,9 +184607,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.get({ + * const res = await aiplatform.ragCorpora.operations.get({ * // The name of the operation resource. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob/operations/my-operation', + * name: 'ragCorpora/[^/]+/operations/my-operation', * }); * console.log(res.data); * @@ -167491,27 +184636,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params?: Params$Resource$Ragcorpora$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Ragcorpora$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Ragcorpora$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Get, + params: Params$Resource$Ragcorpora$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -167519,7 +184663,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$Get + | Params$Resource$Ragcorpora$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -167535,13 +184679,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + {}) as Params$Resource$Ragcorpora$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$Get; + params = {} as Params$Resource$Ragcorpora$Operations$Get; options = {}; } @@ -167605,11 +184748,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.projects.locations.tuningJobs.operations.list({ + * const res = await aiplatform.ragCorpora.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'projects/my-project/locations/my-location/tuningJobs/my-tuningJob', + * name: 'ragCorpora/[^/]+', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -167640,29 +184783,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params?: Params$Resource$Ragcorpora$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Ragcorpora$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Ragcorpora$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Tuningjobs$Operations$List, + params: Params$Resource$Ragcorpora$Operations$List, callback: BodyResponseCallback ): void; list( @@ -167670,7 +184813,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Tuningjobs$Operations$List + | Params$Resource$Ragcorpora$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -167688,13 +184831,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; + {}) as Params$Resource$Ragcorpora$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Tuningjobs$Operations$List; + params = {} as Params$Resource$Ragcorpora$Operations$List; options = {}; } @@ -167732,223 +184874,9 @@ export namespace aiplatform_v1 { ); } } - } - - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Tuningjobs$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - - export class Resource$Publishers { - context: APIRequestContext; - models: Resource$Publishers$Models; - constructor(context: APIRequestContext) { - this.context = context; - this.models = new Resource$Publishers$Models(this.context); - } - } - - export class Resource$Publishers$Models { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Return a list of tokens based on the input text. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.publishers.models.computeTokens({ - * // Required. The name of the Endpoint requested to get lists of tokens and token ids. - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "instances": [], - * // "model": "my_model" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "tokensInfo": [] - * // } - * } - * - * 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. - */ - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - options: StreamMethodOptions - ): Promise>; - computeTokens( - params?: Params$Resource$Publishers$Models$Computetokens, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - computeTokens( - params: Params$Resource$Publishers$Models$Computetokens, - callback: BodyResponseCallback - ): void; - computeTokens( - callback: BodyResponseCallback - ): void; - computeTokens( - paramsOrCallback?: - | Params$Resource$Publishers$Models$Computetokens - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Computetokens; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Computetokens; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}:computeTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } /** - * Perform a token counting. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -167977,182 +184905,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.countTokens({ - * // Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contents": [], - * // "generationConfig": {}, - * // "instances": [], - * // "model": "my_model", - * // "systemInstruction": {}, - * // "tools": [] - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "promptTokensDetails": [], - * // "totalBillableCharacters": 0, - * // "totalTokens": 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. - */ - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - options: StreamMethodOptions - ): Promise>; - countTokens( - params?: Params$Resource$Publishers$Models$Counttokens, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - countTokens( - params: Params$Resource$Publishers$Models$Counttokens, - callback: BodyResponseCallback - ): void; - countTokens( - callback: BodyResponseCallback - ): void; - countTokens( - paramsOrCallback?: - | Params$Resource$Publishers$Models$Counttokens - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Counttokens; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Counttokens; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+endpoint}:countTokens').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Fetch an asynchronous online prediction operation. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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/cloud-platform.read-only', - * ], - * }); - * - * // 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 aiplatform.publishers.models.fetchPredictOperation({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, + * const res = await aiplatform.ragCorpora.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * @@ -168178,36 +184935,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions ): Promise>; - fetchPredictOperation( - params?: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params?: Params$Resource$Ragcorpora$Operations$Wait, options?: MethodOptions ): Promise>; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchPredictOperation( - params: Params$Resource$Publishers$Models$Fetchpredictoperation, + wait( + params: Params$Resource$Ragcorpora$Operations$Wait, callback: BodyResponseCallback ): void; - fetchPredictOperation( + wait( callback: BodyResponseCallback ): void; - fetchPredictOperation( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Fetchpredictoperation + | Params$Resource$Ragcorpora$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -168223,12 +184979,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Fetchpredictoperation; + {}) as Params$Resource$Ragcorpora$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Fetchpredictoperation; + params = {} as Params$Resource$Ragcorpora$Operations$Wait; options = {}; } @@ -168241,18 +184997,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:fetchPredictOperation').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -168264,9 +185017,78 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Ragcorpora$Operations$Cancel extends StandardParameters { /** - * Generate content with multimodal inputs. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Ragcorpora$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Ragcorpora$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Ragcorpora$Ragfiles { + context: APIRequestContext; + operations: Resource$Ragcorpora$Ragfiles$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Ragcorpora$Ragfiles$Operations( + this.context + ); + } + } + + export class Resource$Ragcorpora$Ragfiles$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -168287,10 +185109,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -168298,37 +185117,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.generateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} - * // } + * // {} * } * * main().catch(e => { @@ -168343,61 +185139,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; - generateContent( - params?: Params$Resource$Publishers$Models$Generatecontent, + cancel( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, + ): Promise>; + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - generateContent( - params: Params$Resource$Publishers$Models$Generatecontent, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateContent( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + callback: BodyResponseCallback ): void; - generateContent( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Publishers$Models$Generatecontent - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Generatecontent; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Generatecontent; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; options = {}; } @@ -168410,34 +185198,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:generateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a Model Garden publisher model. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -168466,32 +185249,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.get({ - * // Optional. Token used to access Hugging Face gated models. - * huggingFaceToken: 'placeholder-value', - * // Optional. Boolean indicates whether the requested model is a Hugging Face model. - * isHuggingFaceModel: 'placeholder-value', - * // Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. - * languageCode: 'placeholder-value', - * // Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` - * name: 'publishers/my-publisher/models/my-model', - * // Optional. PublisherModel view specifying which fields to read. - * view: 'placeholder-value', + * const res = await aiplatform.ragCorpora.ragFiles.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "frameworks": [], - * // "launchStage": "my_launchStage", - * // "name": "my_name", - * // "openSourceCategory": "my_openSourceCategory", - * // "predictSchemata": {}, - * // "publisherModelTemplate": "my_publisherModelTemplate", - * // "supportedActions": {}, - * // "versionId": "my_versionId", - * // "versionState": "my_versionState" - * // } + * // {} * } * * main().catch(e => { @@ -168506,61 +185271,53 @@ export namespace aiplatform_v1 { * @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$Publishers$Models$Get, + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Publishers$Models$Get, + delete( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Publishers$Models$Get, + ): Promise>; + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Publishers$Models$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Publishers$Models$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Publishers$Models$Get - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Get; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Get; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; options = {}; } @@ -168574,7 +185331,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -168585,18 +185342,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -168617,10 +185373,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -168628,30 +185381,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predict({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.get({ + * // The name of the operation resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', * }); * console.log(res.data); * * // Example response * // { - * // "deployedModelId": "my_deployedModelId", + * // "done": false, + * // "error": {}, * // "metadata": {}, - * // "model": "my_model", - * // "modelDisplayName": "my_modelDisplayName", - * // "modelVersionId": "my_modelVersionId", - * // "predictions": [] + * // "name": "my_name", + * // "response": {} * // } * } * @@ -168667,61 +185409,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predict( - params: Params$Resource$Publishers$Models$Predict, + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions ): Promise>; - predict( - params?: Params$Resource$Publishers$Models$Predict, + get( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - predict( - params: Params$Resource$Publishers$Models$Predict, + ): Promise>; + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predict( - params: Params$Resource$Publishers$Models$Predict, - callback: BodyResponseCallback + get( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + callback: BodyResponseCallback ): void; - predict( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - predict( + get( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predict - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predict; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predict; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; options = {}; } @@ -168734,33 +185471,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predict').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -168781,10 +185514,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -168792,29 +185522,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.predictLongRunning({ - * // Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - * endpoint: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "instances": [], - * // "labels": {}, - * // "parameters": {} - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -168830,57 +185556,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions ): Promise>; - predictLongRunning( - params?: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options?: MethodOptions - ): Promise>; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - predictLongRunning( - params: Params$Resource$Publishers$Models$Predictlongrunning, - callback: BodyResponseCallback + list( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + callback: BodyResponseCallback ): void; - predictLongRunning( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - predictLongRunning( + list( paramsOrCallback?: - | Params$Resource$Publishers$Models$Predictlongrunning - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Predictlongrunning; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Predictlongrunning; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$List; options = {}; } @@ -168893,32 +185623,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+endpoint}:predictLongRunning').replace( + url: (rootUrl + '/v1/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['endpoint'], - pathParams: ['endpoint'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Generate content with multimodal inputs with streaming support. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -168939,10 +185671,7 @@ export namespace aiplatform_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/cloud-platform.read-only', - * ], + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], * }); * * // Acquire an auth client, and bind it to all future calls @@ -168950,36 +185679,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.publishers.models.streamGenerateContent({ - * // Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - * model: 'publishers/my-publisher/models/my-model', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "cachedContent": "my_cachedContent", - * // "contents": [], - * // "generationConfig": {}, - * // "labels": {}, - * // "modelArmorConfig": {}, - * // "safetySettings": [], - * // "systemInstruction": {}, - * // "toolConfig": {}, - * // "tools": [] - * // } - * }, + * const res = await aiplatform.ragCorpora.ragFiles.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "candidates": [], - * // "createTime": "my_createTime", - * // "modelVersion": "my_modelVersion", - * // "promptFeedback": {}, - * // "responseId": "my_responseId", - * // "usageMetadata": {} + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -168995,61 +185709,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions ): Promise>; - streamGenerateContent( - params?: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + ): Promise>; + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamGenerateContent( - params: Params$Resource$Publishers$Models$Streamgeneratecontent, - callback: BodyResponseCallback + wait( + params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + callback: BodyResponseCallback ): void; - streamGenerateContent( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - streamGenerateContent( + wait( paramsOrCallback?: - | Params$Resource$Publishers$Models$Streamgeneratecontent - | BodyResponseCallback + | Params$Resource$Ragcorpora$Ragfiles$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Publishers$Models$Streamgeneratecontent; + {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Publishers$Models$Streamgeneratecontent; + params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; options = {}; } @@ -169062,145 +185771,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+model}:streamGenerateContent').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['model'], - pathParams: ['model'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Publishers$Models$Computetokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to get lists of tokens and token ids. - */ - endpoint?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ComputeTokensRequest; - } - export interface Params$Resource$Publishers$Models$Counttokens extends StandardParameters { - /** - * Required. The name of the Endpoint requested to perform token counting. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1CountTokensRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Fetchpredictoperation extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` - */ - endpoint?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be deleted. */ - requestBody?: Schema$GoogleCloudAiplatformV1FetchPredictOperationRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Generatecontent extends StandardParameters { - /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - model?: string; - + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + name?: string; } - export interface Params$Resource$Publishers$Models$Get extends StandardParameters { - /** - * Optional. Token used to access Hugging Face gated models. - */ - huggingFaceToken?: string; - /** - * Optional. Boolean indicates whether the requested model is a Hugging Face model. - */ - isHuggingFaceModel?: boolean; + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$List extends StandardParameters { /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. + * The standard list filter. */ - languageCode?: string; + filter?: string; /** - * Required. The name of the PublisherModel resource. Format: `publishers/{publisher\}/models/{publisher_model\}` + * The name of the operation's parent resource. */ name?: string; /** - * Optional. PublisherModel view specifying which fields to read. - */ - view?: string; - } - export interface Params$Resource$Publishers$Models$Predict extends StandardParameters { - /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` - */ - endpoint?: string; - - /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictRequest; - } - export interface Params$Resource$Publishers$Models$Predictlongrunning extends StandardParameters { + pageSize?: number; /** - * Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` or `projects/{project\}/locations/{location\}/publishers/{publisher\}/models/{model\}` + * The standard list page token. */ - endpoint?: string; - + pageToken?: string; /** - * Request body metadata + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1PredictLongRunningRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Publishers$Models$Streamgeneratecontent extends StandardParameters { + export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { /** - * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` + * The name of the operation resource to wait on. */ - model?: string; - + name?: string; /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1GenerateContentRequest; + timeout?: string; } - export class Resource$Ragcorpora { + export class Resource$Ragengineconfig { context: APIRequestContext; - operations: Resource$Ragcorpora$Operations; - ragFiles: Resource$Ragcorpora$Ragfiles; + operations: Resource$Ragengineconfig$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Ragcorpora$Operations(this.context); - this.ragFiles = new Resource$Ragcorpora$Ragfiles(this.context); + this.operations = new Resource$Ragengineconfig$Operations(this.context); } } - export class Resource$Ragcorpora$Operations { + export class Resource$Ragengineconfig$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -169236,9 +185889,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.cancel({ + * const res = await aiplatform.ragEngineConfig.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -169259,31 +185912,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Ragcorpora$Operations$Cancel, + params?: Params$Resource$Ragengineconfig$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Ragcorpora$Operations$Cancel, + params: Params$Resource$Ragengineconfig$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Cancel + | Params$Resource$Ragengineconfig$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169299,12 +185952,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Cancel; + {}) as Params$Resource$Ragengineconfig$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Cancel; + params = {} as Params$Resource$Ragengineconfig$Operations$Cancel; options = {}; } @@ -169368,9 +186021,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.delete({ + * const res = await aiplatform.ragEngineConfig.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -169391,31 +186044,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Ragcorpora$Operations$Delete, + params?: Params$Resource$Ragengineconfig$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Ragcorpora$Operations$Delete, + params: Params$Resource$Ragengineconfig$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Delete + | Params$Resource$Ragengineconfig$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169431,12 +186084,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Delete; + {}) as Params$Resource$Ragengineconfig$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Delete; + params = {} as Params$Resource$Ragengineconfig$Operations$Delete; options = {}; } @@ -169500,9 +186153,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.get({ + * const res = await aiplatform.ragEngineConfig.operations.get({ * // The name of the operation resource. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * }); * console.log(res.data); * @@ -169529,27 +186182,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Ragcorpora$Operations$Get, + params?: Params$Resource$Ragengineconfig$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Ragcorpora$Operations$Get, + params: Params$Resource$Ragengineconfig$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -169557,7 +186209,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Get + | Params$Resource$Ragengineconfig$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169573,12 +186225,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Get; + {}) as Params$Resource$Ragengineconfig$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Get; + params = {} as Params$Resource$Ragengineconfig$Operations$Get; options = {}; } @@ -169642,11 +186294,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.list({ + * const res = await aiplatform.ragEngineConfig.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'ragCorpora/[^/]+', + * name: 'ragEngineConfig', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -169677,29 +186329,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Ragcorpora$Operations$List, + params?: Params$Resource$Ragengineconfig$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Ragcorpora$Operations$List, + params: Params$Resource$Ragengineconfig$Operations$List, callback: BodyResponseCallback ): void; list( @@ -169707,7 +186359,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$List + | Params$Resource$Ragengineconfig$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169725,12 +186377,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$List; + {}) as Params$Resource$Ragengineconfig$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$List; + params = {} as Params$Resource$Ragengineconfig$Operations$List; options = {}; } @@ -169799,9 +186451,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.operations.wait({ + * const res = await aiplatform.ragEngineConfig.operations.wait({ * // The name of the operation resource to wait on. - * name: 'ragCorpora/[^/]+/operations/my-operation', + * name: 'ragEngineConfig/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -169830,27 +186482,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Ragcorpora$Operations$Wait, + params?: Params$Resource$Ragengineconfig$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Ragcorpora$Operations$Wait, + params: Params$Resource$Ragengineconfig$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -169858,7 +186509,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Ragcorpora$Operations$Wait + | Params$Resource$Ragengineconfig$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -169874,12 +186525,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Operations$Wait; + {}) as Params$Resource$Ragengineconfig$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Operations$Wait; + params = {} as Params$Resource$Ragengineconfig$Operations$Wait; options = {}; } @@ -169914,25 +186565,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Ragcorpora$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$Delete extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$Get extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Ragcorpora$Operations$List extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -169954,7 +186605,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Ragcorpora$Operations$Wait extends StandardParameters { + export interface Params$Resource$Ragengineconfig$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -169965,25 +186616,33 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Ragcorpora$Ragfiles { + export class Resource$Reasoningengines { context: APIRequestContext; - operations: Resource$Ragcorpora$Ragfiles$Operations; + memories: Resource$Reasoningengines$Memories; + operations: Resource$Reasoningengines$Operations; + runtimeRevisions: Resource$Reasoningengines$Runtimerevisions; + sandboxEnvironments: Resource$Reasoningengines$Sandboxenvironments; + sandboxEnvironmentSnapshots: Resource$Reasoningengines$Sandboxenvironmentsnapshots; + sandboxEnvironmentTemplates: Resource$Reasoningengines$Sandboxenvironmenttemplates; + sessions: Resource$Reasoningengines$Sessions; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Ragcorpora$Ragfiles$Operations( + this.memories = new Resource$Reasoningengines$Memories(this.context); + this.operations = new Resource$Reasoningengines$Operations(this.context); + this.runtimeRevisions = new Resource$Reasoningengines$Runtimerevisions( this.context ); - } - } - - export class Resource$Ragcorpora$Ragfiles$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + this.sandboxEnvironments = + new Resource$Reasoningengines$Sandboxenvironments(this.context); + this.sandboxEnvironmentSnapshots = + new Resource$Reasoningengines$Sandboxenvironmentsnapshots(this.context); + this.sandboxEnvironmentTemplates = + new Resource$Reasoningengines$Sandboxenvironmenttemplates(this.context); + this.sessions = new Resource$Reasoningengines$Sessions(this.context); } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Async query using a reasoning engine. * @example * ```js * // Before running the sample: @@ -170012,14 +186671,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * const res = await aiplatform.reasoningEngines.asyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputGcsUri": "my_inputGcsUri", + * // "outputGcsUri": "my_outputGcsUri" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -170034,53 +186708,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + asyncQuery( + params: Params$Resource$Reasoningengines$Asyncquery, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + asyncQuery( + params?: Params$Resource$Reasoningengines$Asyncquery, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, + ): Promise>; + asyncQuery( + params: Params$Resource$Reasoningengines$Asyncquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + asyncQuery( + params: Params$Resource$Reasoningengines$Asyncquery, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel, - callback: BodyResponseCallback + asyncQuery( + params: Params$Resource$Reasoningengines$Asyncquery, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + asyncQuery( + callback: BodyResponseCallback + ): void; + asyncQuery( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Asyncquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Asyncquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Asyncquery; options = {}; } @@ -170093,7 +186770,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:asyncQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -170105,17 +186785,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Cancels an AsyncQueryReasoningEngine operation. * @example * ```js * // Before running the sample: @@ -170144,9 +186824,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * const res = await aiplatform.reasoningEngines.cancelAsyncQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "operationName": "my_operationName" + * // } + * }, * }); * console.log(res.data); * @@ -170166,53 +186854,61 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$Delete, + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + cancelAsyncQuery( + params?: Params$Resource$Reasoningengines$Cancelasyncquery, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Delete, - callback: BodyResponseCallback + cancelAsyncQuery( + params: Params$Resource$Reasoningengines$Cancelasyncquery, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + cancelAsyncQuery( + callback: BodyResponseCallback + ): void; + cancelAsyncQuery( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Cancelasyncquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Cancelasyncquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Delete; + params = {} as Params$Resource$Reasoningengines$Cancelasyncquery; options = {}; } @@ -170225,8 +186921,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -170237,17 +186936,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Creates a reasoning engine. * @example * ```js * // Before running the sample: @@ -170276,9 +186977,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.get({ - * // The name of the operation resource. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', + * const res = await aiplatform.reasoningEngines.create({ + * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -170304,36 +187022,35 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + create( + params?: Params$Resource$Reasoningengines$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Get + | Params$Resource$Reasoningengines$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -170349,12 +187066,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; + {}) as Params$Resource$Reasoningengines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Get; + params = {} as Params$Resource$Reasoningengines$Create; options = {}; } @@ -170367,15 +187084,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/reasoningEngines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { @@ -170389,7 +187109,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a reasoning engine. * @example * ```js * // Before running the sample: @@ -170418,25 +187138,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.delete({ + * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + * force: 'placeholder-value', + * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -170452,61 +187168,56 @@ export namespace aiplatform_v1 { * @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$Ragcorpora$Ragfiles$Operations$List, + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + delete( + params?: Params$Resource$Reasoningengines$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, + delete( + params: Params$Resource$Reasoningengines$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$List; + {}) as Params$Resource$Reasoningengines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$List; + params = {} as Params$Resource$Reasoningengines$Delete; options = {}; } @@ -170519,11 +187230,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -170534,19 +187242,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Executes code statelessly. * @example * ```js * // Before running the sample: @@ -170575,21 +187281,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragCorpora.ragFiles.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'ragCorpora/[^/]+/ragFiles/my-ragFile/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.executeCode({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [] * // } * } * @@ -170605,57 +187313,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + executeCode( + params: Params$Resource$Reasoningengines$Executecode, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + executeCode( + params?: Params$Resource$Reasoningengines$Executecode, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + executeCode( + params: Params$Resource$Reasoningengines$Executecode, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, + executeCode( + params: Params$Resource$Reasoningengines$Executecode, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragcorpora$Ragfiles$Operations$Wait, - callback: BodyResponseCallback + executeCode( + params: Params$Resource$Reasoningengines$Executecode, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + executeCode( + callback: BodyResponseCallback ): void; - wait( + executeCode( paramsOrCallback?: - | Params$Resource$Ragcorpora$Ragfiles$Operations$Wait - | BodyResponseCallback + | Params$Resource$Reasoningengines$Executecode + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Executecode; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragcorpora$Ragfiles$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Executecode; options = {}; } @@ -170668,7 +187380,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:executeCode').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -170680,84 +187395,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Ragcorpora$Ragfiles$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Ragcorpora$Ragfiles$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Ragengineconfig { - context: APIRequestContext; - operations: Resource$Ragengineconfig$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Ragengineconfig$Operations(this.context); - } - } - - export class Resource$Ragengineconfig$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets a reasoning engine. * @example * ```js * // Before running the sample: @@ -170786,14 +187436,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.get({ + * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -170808,53 +187469,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, + get( + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Ragengineconfig$Operations$Cancel, + get( + params?: Params$Resource$Reasoningengines$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Reasoningengines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Ragengineconfig$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Get; options = {}; } @@ -170867,8 +187536,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -170879,17 +187548,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists reasoning engines in a location. * @example * ```js * // Before running the sample: @@ -170918,14 +187589,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The standard list page size. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token. + * pageToken: 'placeholder-value', + * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * parent: 'placeholder-value', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "reasoningEngines": [] + * // } * } * * main().catch(e => { @@ -170940,53 +187620,61 @@ export namespace aiplatform_v1 { * @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$Ragengineconfig$Operations$Delete, + list( + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Ragengineconfig$Operations$Delete, + list( + params?: Params$Resource$Reasoningengines$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Ragengineconfig$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Delete; + {}) as Params$Resource$Reasoningengines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Delete; + params = {} as Params$Resource$Reasoningengines$List; options = {}; } @@ -170999,29 +187687,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/reasoningEngines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Updates a reasoning engine. * @example * ```js * // Before running the sample: @@ -171050,9 +187743,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.get({ - * // The name of the operation resource. - * name: 'ragEngineConfig/operations/my-operation', + * const res = await aiplatform.reasoningEngines.patch({ + * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * // Optional. Mask specifying which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "contextSpec": {}, + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "displayName": "my_displayName", + * // "encryptionSpec": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "spec": {}, + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -171078,36 +187790,35 @@ export namespace aiplatform_v1 { * @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$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Ragengineconfig$Operations$Get, + patch( + params?: Params$Resource$Reasoningengines$Patch, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Reasoningengines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Reasoningengines$Patch, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Ragengineconfig$Operations$Get, + patch( + params: Params$Resource$Reasoningengines$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Get + | Params$Resource$Reasoningengines$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -171123,12 +187834,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Get; + {}) as Params$Resource$Reasoningengines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Get; + params = {} as Params$Resource$Reasoningengines$Patch; options = {}; } @@ -171142,7 +187853,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -171163,7 +187874,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -171192,25 +187903,24 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'ragEngineConfig', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "output": {} * // } * } * @@ -171226,61 +187936,61 @@ export namespace aiplatform_v1 { * @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$Ragengineconfig$Operations$List, + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Ragengineconfig$Operations$List, + query( + params?: Params$Resource$Reasoningengines$Query, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - list( - params: Params$Resource$Ragengineconfig$Operations$List, + query( + params: Params$Resource$Reasoningengines$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Ragengineconfig$Operations$List, + query( + params: Params$Resource$Reasoningengines$Query, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Ragengineconfig$Operations$List, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Query, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + query( + callback: BodyResponseCallback ): void; - list( + query( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$List; + {}) as Params$Resource$Reasoningengines$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$List; + params = {} as Params$Resource$Reasoningengines$Query; options = {}; } @@ -171293,11 +188003,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -171308,19 +188015,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -171349,21 +188056,26 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.ragEngineConfig.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'ragEngineConfig/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] * // } * } * @@ -171379,57 +188091,53 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Ragengineconfig$Operations$Wait, + streamQuery( + params?: Params$Resource$Reasoningengines$Streamquery, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, + ): Promise>; + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Ragengineconfig$Operations$Wait, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Streamquery, + callback: BodyResponseCallback ): void; - wait( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Ragengineconfig$Operations$Wait - | BodyResponseCallback + | Params$Resource$Reasoningengines$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Ragengineconfig$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Ragengineconfig$Operations$Wait; + params = {} as Params$Resource$Reasoningengines$Streamquery; options = {}; } @@ -171442,7 +188150,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -171454,94 +188165,151 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Ragengineconfig$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Reasoningengines$Asyncquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; + } + export interface Params$Resource$Reasoningengines$Cancelasyncquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; + } + export interface Params$Resource$Reasoningengines$Create extends StandardParameters { + /** + * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Delete extends StandardParameters { + /** + * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. + */ + force?: boolean; + /** + * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Executecode extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; + } + export interface Params$Resource$Reasoningengines$Get extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; /** - * The name of the operation resource to be cancelled. + * Optional. The standard list page size. */ - name?: string; - } - export interface Params$Resource$Ragengineconfig$Operations$Delete extends StandardParameters { + pageSize?: number; /** - * The name of the operation resource to be deleted. + * Optional. The standard list page token. */ - name?: string; - } - export interface Params$Resource$Ragengineconfig$Operations$Get extends StandardParameters { + pageToken?: string; /** - * The name of the operation resource. + * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` */ - name?: string; + parent?: string; } - export interface Params$Resource$Ragengineconfig$Operations$List extends StandardParameters { + export interface Params$Resource$Reasoningengines$Patch extends StandardParameters { /** - * The standard list filter. + * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ - filter?: string; + name?: string; /** - * The name of the operation's parent resource. + * Optional. Mask specifying which fields to update. */ - name?: string; + updateMask?: string; + /** - * The standard list page size. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; + } + export interface Params$Resource$Reasoningengines$Query extends StandardParameters { /** - * The standard list page token. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ - pageToken?: string; + name?: 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Request body metadata */ - returnPartialSuccess?: boolean; + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; } - export interface Params$Resource$Ragengineconfig$Operations$Wait extends StandardParameters { + export interface Params$Resource$Reasoningengines$Streamquery extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; } - export class Resource$Reasoningengines { + export class Resource$Reasoningengines$Memories { context: APIRequestContext; - memories: Resource$Reasoningengines$Memories; - operations: Resource$Reasoningengines$Operations; - runtimeRevisions: Resource$Reasoningengines$Runtimerevisions; - sandboxEnvironments: Resource$Reasoningengines$Sandboxenvironments; - sandboxEnvironmentSnapshots: Resource$Reasoningengines$Sandboxenvironmentsnapshots; - sandboxEnvironmentTemplates: Resource$Reasoningengines$Sandboxenvironmenttemplates; - sessions: Resource$Reasoningengines$Sessions; + operations: Resource$Reasoningengines$Memories$Operations; constructor(context: APIRequestContext) { this.context = context; - this.memories = new Resource$Reasoningengines$Memories(this.context); - this.operations = new Resource$Reasoningengines$Operations(this.context); - this.runtimeRevisions = new Resource$Reasoningengines$Runtimerevisions( + this.operations = new Resource$Reasoningengines$Memories$Operations( this.context ); - this.sandboxEnvironments = - new Resource$Reasoningengines$Sandboxenvironments(this.context); - this.sandboxEnvironmentSnapshots = - new Resource$Reasoningengines$Sandboxenvironmentsnapshots(this.context); - this.sandboxEnvironmentTemplates = - new Resource$Reasoningengines$Sandboxenvironmenttemplates(this.context); - this.sessions = new Resource$Reasoningengines$Sessions(this.context); + } + } + + export class Resource$Reasoningengines$Memories$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Async query using a reasoning engine. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -171570,29 +188338,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.asyncQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputGcsUri": "my_inputGcsUri", - * // "outputGcsUri": "my_outputGcsUri" - * // } - * }, + * const res = await aiplatform.reasoningEngines.memories.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -171607,57 +188360,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - asyncQuery( - params: Params$Resource$Reasoningengines$Asyncquery, + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions ): Promise>; - asyncQuery( - params?: Params$Resource$Reasoningengines$Asyncquery, + cancel( + params?: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options?: MethodOptions - ): Promise>; - asyncQuery( - params: Params$Resource$Reasoningengines$Asyncquery, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - asyncQuery( - params: Params$Resource$Reasoningengines$Asyncquery, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - asyncQuery( - params: Params$Resource$Reasoningengines$Asyncquery, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - asyncQuery( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + callback: BodyResponseCallback ): void; - asyncQuery( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Asyncquery - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Asyncquery; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Asyncquery; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Cancel; options = {}; } @@ -171670,10 +188420,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:asyncQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -171685,17 +188432,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Cancels an AsyncQueryReasoningEngine operation. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -171724,17 +188471,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.cancelAsyncQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "operationName": "my_operationName" - * // } - * }, + * const res = await aiplatform.reasoningEngines.memories.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -171754,61 +188493,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancelAsyncQuery( - params: Params$Resource$Reasoningengines$Cancelasyncquery, + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions ): Promise>; - cancelAsyncQuery( - params?: Params$Resource$Reasoningengines$Cancelasyncquery, + delete( + params?: Params$Resource$Reasoningengines$Memories$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - cancelAsyncQuery( - params: Params$Resource$Reasoningengines$Cancelasyncquery, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancelAsyncQuery( - params: Params$Resource$Reasoningengines$Cancelasyncquery, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancelAsyncQuery( - params: Params$Resource$Reasoningengines$Cancelasyncquery, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancelAsyncQuery( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Memories$Operations$Delete, + callback: BodyResponseCallback ): void; - cancelAsyncQuery( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Cancelasyncquery - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Cancelasyncquery; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Cancelasyncquery; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Delete; options = {}; } @@ -171821,11 +188553,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancelAsyncQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -171836,19 +188565,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -171877,26 +188604,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.create({ - * // Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.reasoningEngines.memories.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', * }); * console.log(res.data); * @@ -171922,36 +188632,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Create, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Reasoningengines$Create, + get( + params?: Params$Resource$Reasoningengines$Memories$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Create, + get( + params: Params$Resource$Reasoningengines$Memories$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Create + | Params$Resource$Reasoningengines$Memories$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -171967,12 +188676,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Create; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Create; + params = {} as Params$Resource$Reasoningengines$Memories$Operations$Get; options = {}; } @@ -171985,18 +188694,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -172010,7 +188716,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -172039,21 +188745,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.delete({ - * // Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - * force: 'placeholder-value', - * // Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.reasoningEngines.memories.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -172069,57 +188779,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Delete, + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Delete, + list( + params?: Params$Resource$Reasoningengines$Memories$Operations$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Memories$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Delete; + {}) as Params$Resource$Reasoningengines$Memories$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Delete; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$List; options = {}; } @@ -172132,8 +188847,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -172144,17 +188862,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Executes code statelessly. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -172183,23 +188903,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.executeCode({ - * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [] - * // } - * }, + * const res = await aiplatform.reasoningEngines.memories.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -172215,61 +188933,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - executeCode( - params: Params$Resource$Reasoningengines$Executecode, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions ): Promise>; - executeCode( - params?: Params$Resource$Reasoningengines$Executecode, + wait( + params?: Params$Resource$Reasoningengines$Memories$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - executeCode( - params: Params$Resource$Reasoningengines$Executecode, + ): Promise>; + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - executeCode( - params: Params$Resource$Reasoningengines$Executecode, + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - executeCode( - params: Params$Resource$Reasoningengines$Executecode, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + callback: BodyResponseCallback ): void; - executeCode( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - executeCode( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Executecode - | BodyResponseCallback + | Params$Resource$Reasoningengines$Memories$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Executecode; + {}) as Params$Resource$Reasoningengines$Memories$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Executecode; + params = + {} as Params$Resource$Reasoningengines$Memories$Operations$Wait; options = {}; } @@ -172282,10 +188996,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:executeCode').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -172297,19 +189008,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { /** - * Gets a reasoning engine. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Memories$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Reasoningengines$Memories$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Reasoningengines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -172338,25 +189105,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.get({ - * // Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', + * const res = await aiplatform.reasoningEngines.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } + * // {} * } * * main().catch(e => { @@ -172371,61 +189127,53 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Get, + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Get, + cancel( + params?: Params$Resource$Reasoningengines$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - get( - params: Params$Resource$Reasoningengines$Get, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Reasoningengines$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Get; + {}) as Params$Resource$Reasoningengines$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Get; + params = {} as Params$Resource$Reasoningengines$Operations$Cancel; options = {}; } @@ -172438,8 +189186,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -172450,19 +189198,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists reasoning engines in a location. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -172491,23 +189237,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The standard list page size. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token. - * pageToken: 'placeholder-value', - * // Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` - * parent: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "reasoningEngines": [] - * // } + * // {} * } * * main().catch(e => { @@ -172522,61 +189259,53 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$List, + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$List, + delete( + params?: Params$Resource$Reasoningengines$Operations$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Reasoningengines$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Operations$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$List; + {}) as Params$Resource$Reasoningengines$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$List; + params = {} as Params$Resource$Reasoningengines$Operations$Delete; options = {}; } @@ -172589,34 +189318,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/reasoningEngines').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -172645,28 +189369,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.patch({ - * // Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * // Optional. Mask specifying which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "contextSpec": {}, - * // "createTime": "my_createTime", - * // "description": "my_description", - * // "displayName": "my_displayName", - * // "encryptionSpec": {}, - * // "etag": "my_etag", - * // "labels": {}, - * // "name": "my_name", - * // "spec": {}, - * // "updateTime": "my_updateTime" - * // } - * }, + * const res = await aiplatform.reasoningEngines.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', * }); * console.log(res.data); * @@ -172692,36 +189397,35 @@ export namespace aiplatform_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$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Reasoningengines$Patch, + get( + params?: Params$Resource$Reasoningengines$Operations$Get, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Reasoningengines$Patch, + get( + params: Params$Resource$Reasoningengines$Operations$Get, callback: BodyResponseCallback ): void; - patch( + get( callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Patch + | Params$Resource$Reasoningengines$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -172737,12 +189441,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Patch; + {}) as Params$Resource$Reasoningengines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Patch; + params = {} as Params$Resource$Reasoningengines$Operations$Get; options = {}; } @@ -172756,7 +189460,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -172777,7 +189481,7 @@ export namespace aiplatform_v1 { } /** - * Queries using a reasoning engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -172806,24 +189510,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * const res = await aiplatform.reasoningEngines.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "output": {} + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -172839,61 +189544,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Reasoningengines$Query, + list( + params?: Params$Resource$Reasoningengines$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, + list( + params: Params$Resource$Reasoningengines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Query, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Operations$List, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - query( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Query - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Query; + {}) as Params$Resource$Reasoningengines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Query; + params = {} as Params$Resource$Reasoningengines$Operations$List; options = {}; } @@ -172906,8 +189611,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -172918,19 +189626,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Streams queries using a reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -172959,26 +189667,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * const res = await aiplatform.reasoningEngines.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -172994,53 +189697,56 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Reasoningengines$Streamquery, + wait( + params?: Params$Resource$Reasoningengines$Operations$Wait, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, + ): Promise>; + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Streamquery, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Operations$Wait, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + wait( + callback: BodyResponseCallback + ): void; + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Streamquery - | BodyResponseCallback + | Params$Resource$Reasoningengines$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Streamquery; + {}) as Params$Resource$Reasoningengines$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Streamquery; + params = {} as Params$Resource$Reasoningengines$Operations$Wait; options = {}; } @@ -173053,10 +189759,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -173068,151 +189771,75 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Reasoningengines$Asyncquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1AsyncQueryReasoningEngineRequest; - } - export interface Params$Resource$Reasoningengines$Cancelasyncquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelAsyncQueryReasoningEngineRequest; - } - export interface Params$Resource$Reasoningengines$Create extends StandardParameters { - /** - * Required. The resource name of the Location to create the ReasoningEngine in. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Reasoningengines$Delete extends StandardParameters { - /** - * Optional. If set to true, child resources of this reasoning engine will also be deleted. Otherwise, the request will fail with FAILED_PRECONDITION error when the reasoning engine has undeleted child resources. - */ - force?: boolean; - /** - * Required. The name of the ReasoningEngine resource to be deleted. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Executecode extends StandardParameters { - /** - * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExecuteCodeRequest; - } - export interface Params$Resource$Reasoningengines$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$Cancel extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Reasoningengines$List extends StandardParameters { - /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. The standard list page size. - */ - pageSize?: number; + export interface Params$Resource$Reasoningengines$Operations$Delete extends StandardParameters { /** - * Optional. The standard list page token. + * The name of the operation resource to be deleted. */ - pageToken?: string; + name?: string; + } + export interface Params$Resource$Reasoningengines$Operations$Get extends StandardParameters { /** - * Required. The resource name of the Location to list the ReasoningEngines from. Format: `projects/{project\}/locations/{location\}` + * The name of the operation resource. */ - parent?: string; + name?: string; } - export interface Params$Resource$Reasoningengines$Patch extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$List extends StandardParameters { /** - * Identifier. The resource name of the ReasoningEngine. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The standard list filter. */ - name?: string; + filter?: string; /** - * Optional. Mask specifying which fields to update. + * The name of the operation's parent resource. */ - updateMask?: string; - + name?: string; /** - * Request body metadata + * The standard list page size. */ - requestBody?: Schema$GoogleCloudAiplatformV1ReasoningEngine; - } - export interface Params$Resource$Reasoningengines$Query extends StandardParameters { + pageSize?: number; /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The standard list page token. */ - name?: string; - + pageToken?: string; /** - * Request body metadata + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + returnPartialSuccess?: boolean; } - export interface Params$Resource$Reasoningengines$Streamquery extends StandardParameters { + export interface Params$Resource$Reasoningengines$Operations$Wait extends StandardParameters { /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * The name of the operation resource to wait on. */ name?: string; - /** - * Request body metadata + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; - } - - export class Resource$Reasoningengines$Memories { - context: APIRequestContext; - operations: Resource$Reasoningengines$Memories$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Reasoningengines$Memories$Operations( - this.context - ); - } + timeout?: string; } - export class Resource$Reasoningengines$Memories$Operations { + export class Resource$Reasoningengines$Runtimerevisions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -173241,14 +189868,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * const res = await aiplatform.reasoningEngines.runtimeRevisions.query({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "output": {} + * // } * } * * main().catch(e => { @@ -173263,54 +189901,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + query( + params: Params$Resource$Reasoningengines$Runtimerevisions$Query, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + query( + params?: Params$Resource$Reasoningengines$Runtimerevisions$Query, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + query( + params: Params$Resource$Reasoningengines$Runtimerevisions$Query, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Runtimerevisions$Query, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Memories$Operations$Cancel, - callback: BodyResponseCallback + query( + params: Params$Resource$Reasoningengines$Runtimerevisions$Query, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + query( + callback: BodyResponseCallback + ): void; + query( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Runtimerevisions$Query + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Runtimerevisions$Query; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Runtimerevisions$Query; options = {}; } @@ -173323,7 +189968,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -173335,17 +189980,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Streams queries using a reasoning engine. * @example * ```js * // Before running the sample: @@ -173374,14 +190021,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * const res = await aiplatform.reasoningEngines.runtimeRevisions.streamQuery({ + * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * name: 'reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "classMethod": "my_classMethod", + * // "input": {} + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "contentType": "my_contentType", + * // "data": "my_data", + * // "extensions": [] + * // } * } * * main().catch(e => { @@ -173396,54 +190056,54 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Operations$Delete, + streamQuery( + params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Memories$Operations$Delete, + streamQuery( + params?: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, + ): Promise>; + streamQuery( + params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Memories$Operations$Delete, - callback: BodyResponseCallback + streamQuery( + params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + streamQuery(callback: BodyResponseCallback): void; + streamQuery( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Runtimerevisions$Streamquery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Runtimerevisions$Streamquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Delete; + {} as Params$Resource$Reasoningengines$Runtimerevisions$Streamquery; options = {}; } @@ -173456,8 +190116,11 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:streamQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -173468,17 +190131,52 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Runtimerevisions$Query extends StandardParameters { /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; + } + export interface Params$Resource$Reasoningengines$Runtimerevisions$Streamquery extends StandardParameters { + /** + * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; + } + + export class Resource$Reasoningengines$Sandboxenvironments { + context: APIRequestContext; + operations: Resource$Reasoningengines$Sandboxenvironments$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Reasoningengines$Sandboxenvironments$Operations( + this.context + ); + } + + /** + * Creates a SandboxEnvironment in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -173507,9 +190205,29 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.get({ - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.create({ + * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", + * // "name": "my_name", + * // "owner": "my_owner", + * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", + * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -173535,36 +190253,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Memories$Operations$Get, + create( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Memories$Operations$Get, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Get + | Params$Resource$Reasoningengines$Sandboxenvironments$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -173580,12 +190297,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Memories$Operations$Get; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Create; options = {}; } @@ -173598,15 +190316,18 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -173620,7 +190341,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -173649,25 +190370,19 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.delete({ + * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -173683,62 +190398,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Memories$Operations$List, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$Memories$Operations$List, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Memories$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Memories$Operations$List; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; options = {}; } @@ -173751,11 +190461,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -173766,19 +190473,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Executes using a sandbox environment. * @example * ```js * // Before running the sample: @@ -173807,21 +190512,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.memories.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/memories/my-memorie/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.execute({ + * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "inputs": [] + * // } + * }, * }); * console.log(res.data); * * // Example response * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} + * // "outputs": [] * // } * } * @@ -173837,58 +190544,62 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Reasoningengines$Memories$Operations$Wait, + execute( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options?: MethodOptions - ): Promise>; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + ): Promise< + GaxiosResponseWithHTTP2 + >; + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Memories$Operations$Wait, - callback: BodyResponseCallback + execute( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + callback: BodyResponseCallback ): void; - wait( - callback: BodyResponseCallback + execute( + callback: BodyResponseCallback ): void; - wait( + execute( paramsOrCallback?: - | Params$Resource$Reasoningengines$Memories$Operations$Wait - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Execute + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Memories$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Memories$Operations$Wait; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; options = {}; } @@ -173901,7 +190612,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -173913,75 +190627,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Reasoningengines$Memories$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Memories$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - */ - returnPartialSuccess?: boolean; - } - export interface Params$Resource$Reasoningengines$Memories$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Reasoningengines$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Gets details of the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -174010,14 +190668,28 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.get({ + * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "connectionInfo": {}, + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", + * // "name": "my_name", + * // "owner": "my_owner", + * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", + * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", + * // "spec": {}, + * // "state": "my_state", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -174032,53 +190704,61 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Reasoningengines$Operations$Cancel, + get( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options?: MethodOptions - ): Promise>; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, + ): Promise< + GaxiosResponseWithHTTP2 + >; + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Cancel; + params = {} as Params$Resource$Reasoningengines$Sandboxenvironments$Get; options = {}; } @@ -174091,8 +190771,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -174103,17 +190783,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Lists SandboxEnvironments in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -174142,14 +190824,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // 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. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "nextPageToken": "my_nextPageToken", + * // "sandboxEnvironments": [] + * // } * } * * main().catch(e => { @@ -174164,53 +190855,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$Delete, + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Operations$Delete, + list( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$List, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Operations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise< + GaxiosResponseWithHTTP2 + > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Delete; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$List; options = {}; } @@ -174223,29 +190923,34 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Pauses the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -174274,9 +190979,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.get({ - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.pause({ + * // Required. The resource name of the sandbox environment to pause. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * @@ -174302,36 +191013,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$Get, + pause( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Pause, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Operations$Get, + pause( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Pause, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Reasoningengines$Operations$Get, + pause( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Operations$Get, + pause( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Pause, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Operations$Get, + pause( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Pause, callback: BodyResponseCallback ): void; - get( + pause( callback: BodyResponseCallback ): void; - get( + pause( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Get + | Params$Resource$Reasoningengines$Sandboxenvironments$Pause | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -174347,12 +191057,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Get; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Pause; options = {}; } @@ -174365,8 +191076,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:pause').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -174387,7 +191098,7 @@ export namespace aiplatform_v1 { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Resumes the specific SandboxEnvironment. * @example * ```js * // Before running the sample: @@ -174416,25 +191127,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.list({ - * // The standard list filter. - * filter: 'placeholder-value', - * // The name of the operation's parent resource. - * name: 'reasoningEngines/my-reasoningEngine', - * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. - * returnPartialSuccess: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.resume({ + * // Required. The resource name of the sandbox environment to resume. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // {} + * }, * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "operations": [], - * // "unreachable": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -174450,61 +191161,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Operations$List, + resume( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Resume, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$Operations$List, + resume( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Resume, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$Operations$List, + ): Promise>; + resume( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Operations$List, + resume( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Resume, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Operations$List, - callback: BodyResponseCallback + resume( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Resume, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - list( + resume( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$List; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Resume; options = {}; } @@ -174517,11 +191224,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:resume').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -174532,19 +191236,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource. * @example * ```js * // Before running the sample: @@ -174573,11 +191275,27 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * const res = await aiplatform.reasoningEngines.sandboxEnvironments.snapshot({ + * // Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "displayName": "my_displayName", + * // "expireTime": "my_expireTime", + * // "name": "my_name", + * // "owner": "my_owner", + * // "parentSnapshot": "my_parentSnapshot", + * // "postSnapshotAction": "my_postSnapshotAction", + * // "sizeBytes": "my_sizeBytes", + * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", + * // "ttl": "my_ttl", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -174603,36 +191321,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + snapshot( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Reasoningengines$Operations$Wait, + snapshot( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + snapshot( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + snapshot( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Operations$Wait, + snapshot( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, callback: BodyResponseCallback ): void; - wait( + snapshot( callback: BodyResponseCallback ): void; - wait( + snapshot( paramsOrCallback?: - | Params$Resource$Reasoningengines$Operations$Wait + | Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -174648,12 +191365,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Operations$Wait; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot; options = {}; } @@ -174666,7 +191384,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:snapshot').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -174688,65 +191409,100 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Reasoningengines$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { + /** + * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; } - export interface Params$Resource$Reasoningengines$Operations$Delete extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; } - export interface Params$Resource$Reasoningengines$Operations$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; } - export interface Params$Resource$Reasoningengines$Operations$List extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$List extends StandardParameters { /** - * The standard list filter. + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * The name of the operation's parent resource. + * 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. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Pause extends StandardParameters { + /** + * Required. The resource name of the sandbox environment to pause. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ name?: string; + /** - * The standard list page size. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudAiplatformV1PauseSandboxEnvironmentRequest; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Resume extends StandardParameters { /** - * The standard list page token. + * Required. The resource name of the sandbox environment to resume. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` */ - pageToken?: string; + name?: 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * Request body metadata */ - returnPartialSuccess?: boolean; + requestBody?: Schema$GoogleCloudAiplatformV1ResumeSandboxEnvironmentRequest; } - export interface Params$Resource$Reasoningengines$Operations$Wait extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot extends StandardParameters { /** - * The name of the operation resource to wait on. + * Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. */ name?: string; + /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Request body metadata */ - timeout?: string; + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSnapshot; } - export class Resource$Reasoningengines$Runtimerevisions { + export class Resource$Reasoningengines$Sandboxenvironments$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Queries using a reasoning engine. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -174764,36 +191520,26 @@ export namespace aiplatform_v1 { * const {google} = require('googleapis'); * const aiplatform = google.aiplatform('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 aiplatform.reasoningEngines.runtimeRevisions.query({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, + * 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 aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "output": {} - * // } + * // {} * } * * main().catch(e => { @@ -174808,61 +191554,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - query( - params: Params$Resource$Reasoningengines$Runtimerevisions$Query, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions ): Promise>; - query( - params?: Params$Resource$Reasoningengines$Runtimerevisions$Query, + cancel( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - query( - params: Params$Resource$Reasoningengines$Runtimerevisions$Query, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - query( - params: Params$Resource$Reasoningengines$Runtimerevisions$Query, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - query( - params: Params$Resource$Reasoningengines$Runtimerevisions$Query, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - query( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + callback: BodyResponseCallback ): void; - query( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Runtimerevisions$Query - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Runtimerevisions$Query; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Runtimerevisions$Query; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; options = {}; } @@ -174875,7 +191614,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:query').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -174887,19 +191626,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Streams queries using a reasoning engine. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -174928,27 +191665,15 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.runtimeRevisions.streamQuery({ - * // Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * name: 'reasoningEngines/my-reasoningEngine/runtimeRevisions/my-runtimeRevision', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "classMethod": "my_classMethod", - * // "input": {} - * // } - * }, - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "contentType": "my_contentType", - * // "data": "my_data", - * // "extensions": [] - * // } + * // {} * } * * main().catch(e => { @@ -174963,54 +191688,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - streamQuery( - params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions ): Promise>; - streamQuery( - params?: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options?: MethodOptions - ): Promise>; - streamQuery( - params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - streamQuery( - params: Params$Resource$Reasoningengines$Runtimerevisions$Streamquery, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + callback: BodyResponseCallback ): void; - streamQuery(callback: BodyResponseCallback): void; - streamQuery( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Runtimerevisions$Streamquery - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Runtimerevisions$Streamquery; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Runtimerevisions$Streamquery; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; options = {}; } @@ -175023,11 +191748,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:streamQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -175038,52 +191760,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Reasoningengines$Runtimerevisions$Query extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1QueryReasoningEngineRequest; - } - export interface Params$Resource$Reasoningengines$Runtimerevisions$Streamquery extends StandardParameters { - /** - * Required. The name of the ReasoningEngine resource to use. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1StreamQueryReasoningEngineRequest; - } - - export class Resource$Reasoningengines$Sandboxenvironments { - context: APIRequestContext; - operations: Resource$Reasoningengines$Sandboxenvironments$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Reasoningengines$Sandboxenvironments$Operations( - this.context - ); - } /** - * Creates a SandboxEnvironment in a given reasoning engine. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -175112,30 +191799,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.create({ - * // Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - * parent: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "connectionInfo": {}, - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", - * // "name": "my_name", - * // "owner": "my_owner", - * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", - * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", - * // "spec": {}, - * // "state": "my_state", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -175160,36 +191828,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Create, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + get( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options?: MethodOptions ): Promise>; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Create, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Create + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -175205,13 +191872,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Create; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Create; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; options = {}; } @@ -175224,18 +191891,15 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -175249,7 +191913,7 @@ export namespace aiplatform_v1 { } /** - * Deletes the specific SandboxEnvironment. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -175278,10 +191942,13 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.delete({ - * // Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironments.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -175306,36 +191973,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Delete, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, + wait( + params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Delete, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, callback: BodyResponseCallback ): void; - delete( + wait( callback: BodyResponseCallback ): void; - delete( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Delete + | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -175351,13 +192017,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Delete; + {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; options = {}; } @@ -175370,8 +192036,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -175390,9 +192056,50 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { /** - * Executes using a sandbox environment. + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Reasoningengines$Sandboxenvironmentsnapshots { + context: APIRequestContext; + operations: Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations( + this.context + ); + } + + /** + * Deletes the specific SandboxEnvironmentSnapshot. * @example * ```js * // Before running the sample: @@ -175421,23 +192128,20 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.execute({ - * // Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "inputs": [] - * // } - * }, - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete({ + * // Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', + * }); * console.log(res.data); * * // Example response * // { - * // "outputs": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -175453,62 +192157,57 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - execute( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: StreamMethodOptions ): Promise>; - execute( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - execute( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - execute( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - execute( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Execute, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + callback: BodyResponseCallback ): void; - execute( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - execute( + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Execute - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Execute; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete; options = {}; } @@ -175521,11 +192220,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:execute').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -175536,19 +192232,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets details of the specific SandboxEnvironment. + * Gets details of the specific SandboxEnvironmentSnapshot. * @example * ```js * // Before running the sample: @@ -175577,25 +192271,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.get({ - * // Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * }); + * const res = await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get( + * { + * // Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', + * }, + * ); * console.log(res.data); * * // Example response * // { - * // "connectionInfo": {}, * // "createTime": "my_createTime", * // "displayName": "my_displayName", * // "expireTime": "my_expireTime", - * // "latestSandboxEnvironmentSnapshot": "my_latestSandboxEnvironmentSnapshot", * // "name": "my_name", * // "owner": "my_owner", - * // "sandboxEnvironmentSnapshot": "my_sandboxEnvironmentSnapshot", - * // "sandboxEnvironmentTemplate": "my_sandboxEnvironmentTemplate", - * // "spec": {}, - * // "state": "my_state", + * // "parentSnapshot": "my_parentSnapshot", + * // "postSnapshotAction": "my_postSnapshotAction", + * // "sizeBytes": "my_sizeBytes", + * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", * // "ttl": "my_ttl", * // "updateTime": "my_updateTime" * // } @@ -175614,60 +192308,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Get, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Sandboxenvironments$Get; + params = + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get; options = {}; } @@ -175692,19 +192387,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists SandboxEnvironments in a given reasoning engine. + * Lists SandboxEnvironmentSnapshots in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -175733,22 +192428,23 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // 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. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: 'reasoningEngines/my-reasoningEngine', - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list({ + * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * filter: 'placeholder-value', + * // Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + * pageSize: 'placeholder-value', + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + * pageToken: 'placeholder-value', + * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * parent: 'reasoningEngines/my-reasoningEngine', + * }); * console.log(res.data); * * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironments": [] + * // "sandboxEnvironmentSnapshots": [] * // } * } * @@ -175765,61 +192461,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$List, + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sandboxenvironments$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sandboxenvironments$List, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$List; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List; options = {}; } @@ -175832,10 +192528,9 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sandboxEnvironments').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1/{+parent}/sandboxEnvironmentSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -175847,19 +192542,57 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete extends StandardParameters { /** - * Snapshots the specific SandboxEnvironment resource and creates a SandboxEnvironmentSnapshot resource. + * Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get extends StandardParameters { + /** + * Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List extends StandardParameters { + /** + * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + */ + pageSize?: number; + /** + * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + */ + parent?: string; + } + + export class Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -175888,38 +192621,17 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironments.snapshot({ - * // Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", - * // "name": "my_name", - * // "owner": "my_owner", - * // "parentSnapshot": "my_parentSnapshot", - * // "postSnapshotAction": "my_postSnapshotAction", - * // "sizeBytes": "my_sizeBytes", - * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", - * // "ttl": "my_ttl", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel( + * { + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -175934,58 +192646,54 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - snapshot( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options: StreamMethodOptions ): Promise>; - snapshot( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, + cancel( + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options?: MethodOptions - ): Promise>; - snapshot( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - snapshot( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - snapshot( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - snapshot( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + callback: BodyResponseCallback ): void; - snapshot( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; options = {}; } @@ -175998,10 +192706,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:snapshot').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -176013,88 +192718,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Create extends StandardParameters { - /** - * Required. The resource name of the reasoning engine to create the SandboxEnvironment in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironment; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Delete extends StandardParameters { - /** - * Required. The resource name of the SandboxEnvironment to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Execute extends StandardParameters { - /** - * Required. The resource name of the sandbox environment to execute. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1ExecuteSandboxEnvironmentRequest; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Get extends StandardParameters { - /** - * Required. The resource name of the sandbox environment. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}` - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$List extends StandardParameters { - /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - */ - filter?: string; - /** - * 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. - */ - pageSize?: number; - /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - */ - parent?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Snapshot extends StandardParameters { - /** - * Required. The resource name of the sandbox environment to snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironments/{sandbox_environment\}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentSnapshot; - } - - export class Resource$Reasoningengines$Sandboxenvironments$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -176124,10 +192758,12 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel({ - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }); + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete( + * { + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response @@ -176146,32 +192782,32 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options: StreamMethodOptions ): Promise>; - cancel( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + delete( + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options?: MethodOptions ): Promise>; - cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel, + delete( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -176187,13 +192823,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; options = {}; } @@ -176206,8 +192842,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -176228,7 +192864,7 @@ export namespace aiplatform_v1 { } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -176258,14 +192894,22 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironments.operations.delete({ - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }); + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get( + * { + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * }, + * ); * console.log(res.data); * * // Example response - * // {} + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } * } * * main().catch(e => { @@ -176280,54 +192924,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Operations$Delete, + get( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + get( + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, + ): Promise>; + get( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; options = {}; } @@ -176341,7 +192988,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -176352,17 +192999,17 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -176392,10 +193039,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironments.operations.get({ - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * }); + * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait( + * { + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }, + * ); * console.log(res.data); * * // Example response @@ -176420,36 +193071,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironments$Operations$Get, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, + wait( + params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get, + wait( + params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, callback: BodyResponseCallback ): void; - get( + wait( callback: BodyResponseCallback ): void; - get( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get + | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -176465,13 +193115,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get; + {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; options = {}; } @@ -176484,8 +193134,8 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -176504,9 +193154,50 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Reasoningengines$Sandboxenvironmenttemplates { + context: APIRequestContext; + operations: Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations( + this.context + ); + } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Creates a SandboxEnvironmentTemplate in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -176536,11 +193227,24 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironments.operations.wait({ - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironments/my-sandboxEnvironment/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create({ + * // Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + * parent: 'reasoningEngines/my-reasoningEngine', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "createTime": "my_createTime", + * // "customContainerEnvironment": {}, + * // "defaultContainerEnvironment": {}, + * // "displayName": "my_displayName", + * // "egressControlConfig": {}, + * // "name": "my_name", + * // "state": "my_state", + * // "updateTime": "my_updateTime" + * // } + * }, * }); * console.log(res.data); * @@ -176566,36 +193270,35 @@ export namespace aiplatform_v1 { * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, options: StreamMethodOptions ): Promise>; - wait( - params?: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, + create( + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, options?: MethodOptions ): Promise>; - wait( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait, + create( + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, callback: BodyResponseCallback ): void; - wait( + create( callback: BodyResponseCallback ): void; - wait( + create( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -176611,13 +193314,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create; options = {}; } @@ -176630,15 +193333,17 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -176650,50 +193355,9 @@ export namespace aiplatform_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Cancel extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Delete extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Get extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Reasoningengines$Sandboxenvironments$Operations$Wait extends StandardParameters { - /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - */ - timeout?: string; - } - - export class Resource$Reasoningengines$Sandboxenvironmentsnapshots { - context: APIRequestContext; - operations: Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations( - this.context - ); - } /** - * Deletes the specific SandboxEnvironmentSnapshot. + * Deletes the specific SandboxEnvironmentTemplate. * @example * ```js * // Before running the sample: @@ -176723,9 +193387,9 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.delete({ - * // Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete({ + * // Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', * }); * console.log(res.data); * @@ -176752,27 +193416,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, callback: BodyResponseCallback ): void; delete( @@ -176780,7 +193443,7 @@ export namespace aiplatform_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -176796,13 +193459,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete; options = {}; } @@ -176837,7 +193500,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of the specific SandboxEnvironmentSnapshot. + * Gets details of the specific SandboxEnvironmentTemplate. * @example * ```js * // Before running the sample: @@ -176866,10 +193529,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.get( + * const res = await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get( * { - * // Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot', + * // Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', * }, * ); * console.log(res.data); @@ -176877,15 +193540,12 @@ export namespace aiplatform_v1 { * // Example response * // { * // "createTime": "my_createTime", + * // "customContainerEnvironment": {}, + * // "defaultContainerEnvironment": {}, * // "displayName": "my_displayName", - * // "expireTime": "my_expireTime", + * // "egressControlConfig": {}, * // "name": "my_name", - * // "owner": "my_owner", - * // "parentSnapshot": "my_parentSnapshot", - * // "postSnapshotAction": "my_postSnapshotAction", - * // "sizeBytes": "my_sizeBytes", - * // "sourceSandboxEnvironment": "my_sourceSandboxEnvironment", - * // "ttl": "my_ttl", + * // "state": "my_state", * // "updateTime": "my_updateTime" * // } * } @@ -176903,61 +193563,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get; options = {}; } @@ -176982,19 +193642,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists SandboxEnvironmentSnapshots in a given reasoning engine. + * Lists SandboxEnvironmentTemplates in a given reasoning engine. * @example * ```js * // Before running the sample: @@ -177024,14 +193684,14 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.list({ + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list({ * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). * filter: 'placeholder-value', - * // Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + * // Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * // Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` * parent: 'reasoningEngines/my-reasoningEngine', * }); * console.log(res.data); @@ -177039,7 +193699,7 @@ export namespace aiplatform_v1 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironmentSnapshots": [] + * // "sandboxEnvironmentTemplates": [] * // } * } * @@ -177056,61 +193716,61 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List, - callback: BodyResponseCallback + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List; options = {}; } @@ -177124,7 +193784,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentSnapshots' + rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -177137,50 +193797,61 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Delete extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create extends StandardParameters { /** - * Required. The resource name of the SandboxEnvironmentSnapshot to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplate; + } + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete extends StandardParameters { + /** + * Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get extends StandardParameters { /** - * Required. The resource name of the sandbox environment snapshot. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentSnapshots/{sandbox_environment_snapshot\}` + * Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$List extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List extends StandardParameters { /** * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). */ filter?: string; /** - * Optional. The maximum number of SandboxEnvironmentSnapshots to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentSnapshots will be returned. Values above 100 will be coerced to 100. + * Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. */ pageSize?: number; /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentSnapshots` call. Provide this to retrieve the subsequent page. + * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The resource name of the reasoning engine to list sandbox environments from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` */ parent?: string; } - export class Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations { + export class Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -177217,10 +193888,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.cancel( + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel( * { * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); @@ -177242,31 +193913,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -177282,13 +193953,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; options = {}; } @@ -177353,10 +194024,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.delete( + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete( * { * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); @@ -177378,31 +194049,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -177418,13 +194089,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; options = {}; } @@ -177489,10 +194160,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.get( + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get( * { * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * }, * ); * console.log(res.data); @@ -177520,27 +194191,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -177548,7 +194218,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -177564,13 +194234,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; options = {}; } @@ -177635,10 +194305,10 @@ export namespace aiplatform_v1 { * * // Do the magic * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentSnapshots.operations.wait( + * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait( * { * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentSnapshots/my-sandboxEnvironmentSnapshot/operations/my-operation', + * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }, @@ -177668,27 +194338,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait, + params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -177696,7 +194365,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait + | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -177712,13 +194381,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; + {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait; + {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; options = {}; } @@ -177753,25 +194422,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Delete extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmentsnapshots$Operations$Wait extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -177782,19 +194451,25 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Reasoningengines$Sandboxenvironmenttemplates { + export class Resource$Reasoningengines$Sessions { + context: APIRequestContext; + operations: Resource$Reasoningengines$Sessions$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Reasoningengines$Sessions$Operations( + this.context + ); + } + } + + export class Resource$Reasoningengines$Sessions$Operations { context: APIRequestContext; - operations: Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations( - this.context - ); } /** - * Creates a SandboxEnvironmentTemplate in a given reasoning engine. + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. * @example * ```js * // Before running the sample: @@ -177823,36 +194498,14 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.create({ - * // Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - * parent: 'reasoningEngines/my-reasoningEngine', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "createTime": "my_createTime", - * // "customContainerEnvironment": {}, - * // "defaultContainerEnvironment": {}, - * // "displayName": "my_displayName", - * // "egressControlConfig": {}, - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" - * // } - * }, - * }); + * const res = await aiplatform.reasoningEngines.sessions.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }); * console.log(res.data); * * // Example response - * // { - * // "done": false, - * // "error": {}, - * // "metadata": {}, - * // "name": "my_name", - * // "response": {} - * // } + * // {} * } * * main().catch(e => { @@ -177867,58 +194520,187 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$Create, + cancel( + params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, + cancel( + params?: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, + ): Promise>; + cancel( + params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, - options: + cancel( + params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Reasoningengines$Sessions$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Reasoningengines$Sessions$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Reasoningengines$Sessions$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').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); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.reasoningEngines.sessions.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }); + * console.log(res.data); + * + * // Example 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$Reasoningengines$Sessions$Operations$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sessions$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create; + {}) as Params$Resource$Reasoningengines$Sessions$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create; + {} as Params$Resource$Reasoningengines$Sessions$Operations$Delete; options = {}; } @@ -177931,31 +194713,29 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specific SandboxEnvironmentTemplate. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * @example * ```js * // Before running the sample: @@ -177984,11 +194764,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.delete({ - * // Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', - * }); + * const res = await aiplatform.reasoningEngines.sessions.operations.get({ + * // The name of the operation resource. + * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -178013,36 +194792,35 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params?: Params$Resource$Reasoningengines$Sessions$Operations$Get, options?: MethodOptions ): Promise>; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Reasoningengines$Sessions$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Reasoningengines$Sessions$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete, + get( + params: Params$Resource$Reasoningengines$Sessions$Operations$Get, callback: BodyResponseCallback ): void; - delete( + get( callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete + | Params$Resource$Reasoningengines$Sessions$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -178058,13 +194836,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete; + {}) as Params$Resource$Reasoningengines$Sessions$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete; + params = {} as Params$Resource$Reasoningengines$Sessions$Operations$Get; options = {}; } @@ -178078,7 +194855,7 @@ export namespace aiplatform_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -178099,7 +194876,7 @@ export namespace aiplatform_v1 { } /** - * Gets details of the specific SandboxEnvironmentTemplate. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * @example * ```js * // Before running the sample: @@ -178128,24 +194905,25 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.get( - * { - * // Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate', - * }, - * ); + * const res = await aiplatform.reasoningEngines.sessions.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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 * // { - * // "createTime": "my_createTime", - * // "customContainerEnvironment": {}, - * // "defaultContainerEnvironment": {}, - * // "displayName": "my_displayName", - * // "egressControlConfig": {}, - * // "name": "my_name", - * // "state": "my_state", - * // "updateTime": "my_updateTime" + * // "nextPageToken": "my_nextPageToken", + * // "operations": [], + * // "unreachable": [] * // } * } * @@ -178161,62 +194939,62 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params?: Params$Resource$Reasoningengines$Sessions$Operations$List, options?: MethodOptions ): Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 >; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Reasoningengines$Sessions$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, + list( + params: Params$Resource$Reasoningengines$Sessions$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Reasoningengines$Sessions$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sessions$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void | Promise< - GaxiosResponseWithHTTP2 + GaxiosResponseWithHTTP2 > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get; + {}) as Params$Resource$Reasoningengines$Sessions$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get; + {} as Params$Resource$Reasoningengines$Sessions$Operations$List; options = {}; } @@ -178229,7 +195007,10 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -178241,19 +195022,19 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists SandboxEnvironmentTemplates in a given reasoning engine. + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example * ```js * // Before running the sample: @@ -178282,23 +195063,21 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.list({ - * // Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). - * filter: 'placeholder-value', - * // Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. - * pageSize: 'placeholder-value', - * // Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. - * pageToken: 'placeholder-value', - * // Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` - * parent: 'reasoningEngines/my-reasoningEngine', - * }); + * const res = await aiplatform.reasoningEngines.sessions.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "nextPageToken": "my_nextPageToken", - * // "sandboxEnvironmentTemplates": [] + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} * // } * } * @@ -178314,62 +195093,57 @@ export namespace aiplatform_v1 { * @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$Reasoningengines$Sandboxenvironmenttemplates$List, + wait( + params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, + wait( + params?: Params$Resource$Reasoningengines$Sessions$Operations$Wait, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, + ): Promise>; + wait( + params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, + wait( + params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List, - callback: BodyResponseCallback + wait( + params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + wait( + callback: BodyResponseCallback ): void; - list( + wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List - | BodyResponseCallback + | Params$Resource$Reasoningengines$Sessions$Operations$Wait + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List; + {}) as Params$Resource$Reasoningengines$Sessions$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List; + {} as Params$Resource$Reasoningengines$Sessions$Operations$Wait; options = {}; } @@ -178382,75 +195156,89 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/{+parent}/sandboxEnvironmentTemplates' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:wait').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Create extends StandardParameters { - /** - * Required. The resource name of the reasoning engine to create the SandboxEnvironmentTemplate in. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}`. - */ - parent?: string; - + export interface Params$Resource$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { /** - * Request body metadata + * The name of the operation resource to be cancelled. */ - requestBody?: Schema$GoogleCloudAiplatformV1SandboxEnvironmentTemplate; + name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Delete extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { /** - * Required. The resource name of the SandboxEnvironmentTemplate to delete. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Get extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sessions$Operations$Get extends StandardParameters { /** - * Required. The resource name of the sandbox environment template. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}/sandboxEnvironmentTemplates/{sandbox_environment_template\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$List extends StandardParameters { + export interface Params$Resource$Reasoningengines$Sessions$Operations$List extends StandardParameters { /** - * Optional. The standard list filter. More detail in [AIP-160](https://google.aip.dev/160). + * The standard list filter. */ filter?: string; /** - * Optional. The maximum number of SandboxEnvironmentTemplates to return. The service may return fewer than this value. If unspecified, at most 100 SandboxEnvironmentTemplates will be returned. + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. */ pageSize?: number; /** - * Optional. The standard list page token, received from a previous `ListSandboxEnvironmentTemplates` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; /** - * Required. The resource name of the reasoning engine to list sandbox environment templates from. Format: `projects/{project\}/locations/{location\}/reasoningEngines/{reasoning_engine\}` + * 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ - parent?: string; + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; } - export class Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations { + export class Resource$Schedules { + context: APIRequestContext; + operations: Resource$Schedules$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Schedules$Operations(this.context); + } + } + + export class Resource$Schedules$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -178486,13 +195274,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.cancel( - * { - * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', - * }, - * ); + * const res = await aiplatform.schedules.operations.cancel({ + * // The name of the operation resource to be cancelled. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -178512,31 +195297,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Schedules$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params?: Params$Resource$Schedules$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Schedules$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Schedules$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel, + params: Params$Resource$Schedules$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel + | Params$Resource$Schedules$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -178552,13 +195337,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; + {}) as Params$Resource$Schedules$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel; + params = {} as Params$Resource$Schedules$Operations$Cancel; options = {}; } @@ -178622,13 +195406,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.delete( - * { - * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', - * }, - * ); + * const res = await aiplatform.schedules.operations.delete({ + * // The name of the operation resource to be deleted. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -178648,31 +195429,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Schedules$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params?: Params$Resource$Schedules$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Schedules$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Schedules$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete, + params: Params$Resource$Schedules$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete + | Params$Resource$Schedules$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -178688,13 +195469,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; + {}) as Params$Resource$Schedules$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete; + params = {} as Params$Resource$Schedules$Operations$Delete; options = {}; } @@ -178758,13 +195538,10 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.get( - * { - * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', - * }, - * ); + * const res = await aiplatform.schedules.operations.get({ + * // The name of the operation resource. + * name: 'schedules/my-schedule/operations/my-operation', + * }); * console.log(res.data); * * // Example response @@ -178790,27 +195567,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Schedules$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params?: Params$Resource$Schedules$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Schedules$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Schedules$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get, + params: Params$Resource$Schedules$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -178818,7 +195594,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get + | Params$Resource$Schedules$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -178834,13 +195610,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; + {}) as Params$Resource$Schedules$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get; + params = {} as Params$Resource$Schedules$Operations$Get; options = {}; } @@ -178874,6 +195649,163 @@ export namespace aiplatform_v1 { } } + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.schedules.operations.list({ + * // The standard list filter. + * filter: 'placeholder-value', + * // The name of the operation's parent resource. + * name: 'schedules/my-schedule', + * // 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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default 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$Schedules$Operations$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Schedules$Operations$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Schedules$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Schedules$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Schedules$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Schedules$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Schedules$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Schedules$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.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 + ); + } + } + /** * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. * @example @@ -178904,15 +195836,12 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await aiplatform.reasoningEngines.sandboxEnvironmentTemplates.operations.wait( - * { - * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/sandboxEnvironmentTemplates/my-sandboxEnvironmentTemplate/operations/my-operation', - * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. - * timeout: 'placeholder-value', - * }, - * ); + * const res = await aiplatform.schedules.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'schedules/my-schedule/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); * console.log(res.data); * * // Example response @@ -178938,27 +195867,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + params: Params$Resource$Schedules$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + params?: Params$Resource$Schedules$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + params: Params$Resource$Schedules$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + params: Params$Resource$Schedules$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait, + params: Params$Resource$Schedules$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -178966,7 +195894,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait + | Params$Resource$Schedules$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -178982,13 +195910,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; + {}) as Params$Resource$Schedules$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait; + params = {} as Params$Resource$Schedules$Operations$Wait; options = {}; } @@ -179023,25 +195950,47 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Schedules$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Delete extends StandardParameters { + export interface Params$Resource$Schedules$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Get extends StandardParameters { + export interface Params$Resource$Schedules$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sandboxenvironmenttemplates$Operations$Wait extends StandardParameters { + export interface Params$Resource$Schedules$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. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Schedules$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -179052,18 +196001,18 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Reasoningengines$Sessions { + export class Resource$Semanticgovernancepolicies { context: APIRequestContext; - operations: Resource$Reasoningengines$Sessions$Operations; + operations: Resource$Semanticgovernancepolicies$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Reasoningengines$Sessions$Operations( + this.operations = new Resource$Semanticgovernancepolicies$Operations( this.context ); } } - export class Resource$Reasoningengines$Sessions$Operations { + export class Resource$Semanticgovernancepolicies$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -179099,9 +196048,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sessions.operations.cancel({ + * const res = await aiplatform.semanticGovernancePolicies.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }); * console.log(res.data); * @@ -179122,31 +196071,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Semanticgovernancepolicies$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + params?: Params$Resource$Semanticgovernancepolicies$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Semanticgovernancepolicies$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Semanticgovernancepolicies$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Reasoningengines$Sessions$Operations$Cancel, + params: Params$Resource$Semanticgovernancepolicies$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sessions$Operations$Cancel + | Params$Resource$Semanticgovernancepolicies$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179162,13 +196111,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sessions$Operations$Cancel; + {}) as Params$Resource$Semanticgovernancepolicies$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sessions$Operations$Cancel; + {} as Params$Resource$Semanticgovernancepolicies$Operations$Cancel; options = {}; } @@ -179232,9 +196181,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sessions.operations.delete({ + * const res = await aiplatform.semanticGovernancePolicies.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }); * console.log(res.data); * @@ -179255,31 +196204,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Semanticgovernancepolicies$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + params?: Params$Resource$Semanticgovernancepolicies$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Semanticgovernancepolicies$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Semanticgovernancepolicies$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Reasoningengines$Sessions$Operations$Delete, + params: Params$Resource$Semanticgovernancepolicies$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sessions$Operations$Delete + | Params$Resource$Semanticgovernancepolicies$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179295,13 +196244,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sessions$Operations$Delete; + {}) as Params$Resource$Semanticgovernancepolicies$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sessions$Operations$Delete; + {} as Params$Resource$Semanticgovernancepolicies$Operations$Delete; options = {}; } @@ -179365,9 +196314,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sessions.operations.get({ + * const res = await aiplatform.semanticGovernancePolicies.operations.get({ * // The name of the operation resource. - * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * }); * console.log(res.data); * @@ -179394,27 +196343,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Semanticgovernancepolicies$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Reasoningengines$Sessions$Operations$Get, + params?: Params$Resource$Semanticgovernancepolicies$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Semanticgovernancepolicies$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Semanticgovernancepolicies$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Reasoningengines$Sessions$Operations$Get, + params: Params$Resource$Semanticgovernancepolicies$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -179422,7 +196370,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sessions$Operations$Get + | Params$Resource$Semanticgovernancepolicies$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179438,12 +196386,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sessions$Operations$Get; + {}) as Params$Resource$Semanticgovernancepolicies$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Reasoningengines$Sessions$Operations$Get; + params = + {} as Params$Resource$Semanticgovernancepolicies$Operations$Get; options = {}; } @@ -179507,11 +196456,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sessions.operations.list({ + * const res = await aiplatform.semanticGovernancePolicies.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session', + * name: 'semanticGovernancePolicies/my-semanticGovernancePolicie', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -179542,29 +196491,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Semanticgovernancepolicies$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Reasoningengines$Sessions$Operations$List, + params?: Params$Resource$Semanticgovernancepolicies$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Semanticgovernancepolicies$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Semanticgovernancepolicies$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Reasoningengines$Sessions$Operations$List, + params: Params$Resource$Semanticgovernancepolicies$Operations$List, callback: BodyResponseCallback ): void; list( @@ -179572,7 +196521,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sessions$Operations$List + | Params$Resource$Semanticgovernancepolicies$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179590,13 +196539,13 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sessions$Operations$List; + {}) as Params$Resource$Semanticgovernancepolicies$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sessions$Operations$List; + {} as Params$Resource$Semanticgovernancepolicies$Operations$List; options = {}; } @@ -179665,9 +196614,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.reasoningEngines.sessions.operations.wait({ + * const res = await aiplatform.semanticGovernancePolicies.operations.wait({ * // The name of the operation resource to wait on. - * name: 'reasoningEngines/my-reasoningEngine/sessions/my-session/operations/my-operation', + * name: 'semanticGovernancePolicies/my-semanticGovernancePolicie/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -179696,27 +196645,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Semanticgovernancepolicies$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + params?: Params$Resource$Semanticgovernancepolicies$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Semanticgovernancepolicies$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Semanticgovernancepolicies$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Reasoningengines$Sessions$Operations$Wait, + params: Params$Resource$Semanticgovernancepolicies$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -179724,7 +196672,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Reasoningengines$Sessions$Operations$Wait + | Params$Resource$Semanticgovernancepolicies$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179740,13 +196688,13 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Reasoningengines$Sessions$Operations$Wait; + {}) as Params$Resource$Semanticgovernancepolicies$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Reasoningengines$Sessions$Operations$Wait; + {} as Params$Resource$Semanticgovernancepolicies$Operations$Wait; options = {}; } @@ -179781,25 +196729,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Reasoningengines$Sessions$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Semanticgovernancepolicies$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sessions$Operations$Delete extends StandardParameters { + export interface Params$Resource$Semanticgovernancepolicies$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sessions$Operations$Get extends StandardParameters { + export interface Params$Resource$Semanticgovernancepolicies$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Reasoningengines$Sessions$Operations$List extends StandardParameters { + export interface Params$Resource$Semanticgovernancepolicies$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -179821,7 +196769,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Reasoningengines$Sessions$Operations$Wait extends StandardParameters { + export interface Params$Resource$Semanticgovernancepolicies$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -179832,16 +196780,16 @@ export namespace aiplatform_v1 { timeout?: string; } - export class Resource$Schedules { + export class Resource$Servingprofiles { context: APIRequestContext; - operations: Resource$Schedules$Operations; + operations: Resource$Servingprofiles$Operations; constructor(context: APIRequestContext) { this.context = context; - this.operations = new Resource$Schedules$Operations(this.context); + this.operations = new Resource$Servingprofiles$Operations(this.context); } } - export class Resource$Schedules$Operations { + export class Resource$Servingprofiles$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -179877,9 +196825,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.schedules.operations.cancel({ + * const res = await aiplatform.servingProfiles.operations.cancel({ * // The name of the operation resource to be cancelled. - * name: 'schedules/my-schedule/operations/my-operation', + * name: 'servingProfiles/my-servingProfile/operations/my-operation', * }); * console.log(res.data); * @@ -179900,31 +196848,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ cancel( - params: Params$Resource$Schedules$Operations$Cancel, + params: Params$Resource$Servingprofiles$Operations$Cancel, options: StreamMethodOptions ): Promise>; cancel( - params?: Params$Resource$Schedules$Operations$Cancel, + params?: Params$Resource$Servingprofiles$Operations$Cancel, options?: MethodOptions ): Promise>; cancel( - params: Params$Resource$Schedules$Operations$Cancel, + params: Params$Resource$Servingprofiles$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Schedules$Operations$Cancel, + params: Params$Resource$Servingprofiles$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; cancel( - params: Params$Resource$Schedules$Operations$Cancel, + params: Params$Resource$Servingprofiles$Operations$Cancel, callback: BodyResponseCallback ): void; cancel(callback: BodyResponseCallback): void; cancel( paramsOrCallback?: - | Params$Resource$Schedules$Operations$Cancel + | Params$Resource$Servingprofiles$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -179940,12 +196888,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Schedules$Operations$Cancel; + {}) as Params$Resource$Servingprofiles$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Schedules$Operations$Cancel; + params = {} as Params$Resource$Servingprofiles$Operations$Cancel; options = {}; } @@ -180009,9 +196957,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.schedules.operations.delete({ + * const res = await aiplatform.servingProfiles.operations.delete({ * // The name of the operation resource to be deleted. - * name: 'schedules/my-schedule/operations/my-operation', + * name: 'servingProfiles/my-servingProfile/operations/my-operation', * }); * console.log(res.data); * @@ -180032,31 +196980,31 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Schedules$Operations$Delete, + params: Params$Resource$Servingprofiles$Operations$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Schedules$Operations$Delete, + params?: Params$Resource$Servingprofiles$Operations$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Schedules$Operations$Delete, + params: Params$Resource$Servingprofiles$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Schedules$Operations$Delete, + params: Params$Resource$Servingprofiles$Operations$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Schedules$Operations$Delete, + params: Params$Resource$Servingprofiles$Operations$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Schedules$Operations$Delete + | Params$Resource$Servingprofiles$Operations$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -180072,12 +197020,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Schedules$Operations$Delete; + {}) as Params$Resource$Servingprofiles$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Schedules$Operations$Delete; + params = {} as Params$Resource$Servingprofiles$Operations$Delete; options = {}; } @@ -180141,9 +197089,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.schedules.operations.get({ + * const res = await aiplatform.servingProfiles.operations.get({ * // The name of the operation resource. - * name: 'schedules/my-schedule/operations/my-operation', + * name: 'servingProfiles/my-servingProfile/operations/my-operation', * }); * console.log(res.data); * @@ -180170,27 +197118,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Schedules$Operations$Get, + params: Params$Resource$Servingprofiles$Operations$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Schedules$Operations$Get, + params?: Params$Resource$Servingprofiles$Operations$Get, options?: MethodOptions ): Promise>; get( - params: Params$Resource$Schedules$Operations$Get, + params: Params$Resource$Servingprofiles$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Schedules$Operations$Get, + params: Params$Resource$Servingprofiles$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Schedules$Operations$Get, + params: Params$Resource$Servingprofiles$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -180198,7 +197145,7 @@ export namespace aiplatform_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Schedules$Operations$Get + | Params$Resource$Servingprofiles$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -180214,12 +197161,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Schedules$Operations$Get; + {}) as Params$Resource$Servingprofiles$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Schedules$Operations$Get; + params = {} as Params$Resource$Servingprofiles$Operations$Get; options = {}; } @@ -180283,11 +197230,11 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.schedules.operations.list({ + * const res = await aiplatform.servingProfiles.operations.list({ * // The standard list filter. * filter: 'placeholder-value', * // The name of the operation's parent resource. - * name: 'schedules/my-schedule', + * name: 'servingProfiles/my-servingProfile', * // The standard list page size. * pageSize: 'placeholder-value', * // The standard list page token. @@ -180318,29 +197265,29 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Schedules$Operations$List, + params: Params$Resource$Servingprofiles$Operations$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Schedules$Operations$List, + params?: Params$Resource$Servingprofiles$Operations$List, options?: MethodOptions ): Promise< GaxiosResponseWithHTTP2 >; list( - params: Params$Resource$Schedules$Operations$List, + params: Params$Resource$Servingprofiles$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Schedules$Operations$List, + params: Params$Resource$Servingprofiles$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Schedules$Operations$List, + params: Params$Resource$Servingprofiles$Operations$List, callback: BodyResponseCallback ): void; list( @@ -180348,7 +197295,7 @@ export namespace aiplatform_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Schedules$Operations$List + | Params$Resource$Servingprofiles$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -180366,12 +197313,12 @@ export namespace aiplatform_v1 { > | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Schedules$Operations$List; + {}) as Params$Resource$Servingprofiles$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Schedules$Operations$List; + params = {} as Params$Resource$Servingprofiles$Operations$List; options = {}; } @@ -180440,9 +197387,9 @@ export namespace aiplatform_v1 { * google.options({auth: authClient}); * * // Do the magic - * const res = await aiplatform.schedules.operations.wait({ + * const res = await aiplatform.servingProfiles.operations.wait({ * // The name of the operation resource to wait on. - * name: 'schedules/my-schedule/operations/my-operation', + * name: 'servingProfiles/my-servingProfile/operations/my-operation', * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. * timeout: 'placeholder-value', * }); @@ -180471,27 +197418,26 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ wait( - params: Params$Resource$Schedules$Operations$Wait, + params: Params$Resource$Servingprofiles$Operations$Wait, options: StreamMethodOptions ): Promise>; wait( - params?: Params$Resource$Schedules$Operations$Wait, + params?: Params$Resource$Servingprofiles$Operations$Wait, options?: MethodOptions ): Promise>; wait( - params: Params$Resource$Schedules$Operations$Wait, + params: Params$Resource$Servingprofiles$Operations$Wait, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Schedules$Operations$Wait, + params: Params$Resource$Servingprofiles$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( - params: Params$Resource$Schedules$Operations$Wait, + params: Params$Resource$Servingprofiles$Operations$Wait, callback: BodyResponseCallback ): void; wait( @@ -180499,7 +197445,7 @@ export namespace aiplatform_v1 { ): void; wait( paramsOrCallback?: - | Params$Resource$Schedules$Operations$Wait + | Params$Resource$Servingprofiles$Operations$Wait | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -180515,12 +197461,12 @@ export namespace aiplatform_v1 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Schedules$Operations$Wait; + {}) as Params$Resource$Servingprofiles$Operations$Wait; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Schedules$Operations$Wait; + params = {} as Params$Resource$Servingprofiles$Operations$Wait; options = {}; } @@ -180555,25 +197501,25 @@ export namespace aiplatform_v1 { } } - export interface Params$Resource$Schedules$Operations$Cancel extends StandardParameters { + export interface Params$Resource$Servingprofiles$Operations$Cancel extends StandardParameters { /** * The name of the operation resource to be cancelled. */ name?: string; } - export interface Params$Resource$Schedules$Operations$Delete extends StandardParameters { + export interface Params$Resource$Servingprofiles$Operations$Delete extends StandardParameters { /** * The name of the operation resource to be deleted. */ name?: string; } - export interface Params$Resource$Schedules$Operations$Get extends StandardParameters { + export interface Params$Resource$Servingprofiles$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Schedules$Operations$List extends StandardParameters { + export interface Params$Resource$Servingprofiles$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -180595,7 +197541,7 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } - export interface Params$Resource$Schedules$Operations$Wait extends StandardParameters { + export interface Params$Resource$Servingprofiles$Operations$Wait extends StandardParameters { /** * The name of the operation resource to wait on. */ @@ -180959,8 +197905,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Skills$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -181260,8 +198205,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Skills$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -181733,8 +198677,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Specialistpools$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -182034,8 +198977,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Specialistpools$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -182509,8 +199451,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Studies$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -182810,8 +199751,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Studies$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -183283,8 +200223,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Studies$Trials$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -183584,8 +200523,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Studies$Trials$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -184074,8 +201012,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Tensorboards$Experiments$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -184375,8 +201312,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Tensorboards$Experiments$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -184856,8 +201792,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -185159,8 +202094,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Tensorboards$Experiments$Runs$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -185645,8 +202579,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -185950,8 +202883,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Tensorboards$Experiments$Runs$Timeseries$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -186415,8 +203347,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Tensorboards$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -186716,8 +203647,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Tensorboards$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -187189,8 +204119,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Trainingpipelines$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -187490,8 +204419,7 @@ export namespace aiplatform_v1 { wait( params: Params$Resource$Trainingpipelines$Operations$Wait, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; wait( @@ -187963,8 +204891,7 @@ export namespace aiplatform_v1 { get( params: Params$Resource$Tuningjobs$Operations$Get, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( @@ -188187,6 +205114,149 @@ export namespace aiplatform_v1 { ); } } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/aiplatform.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 aiplatform = google.aiplatform('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 aiplatform.tuningJobs.operations.wait({ + * // The name of the operation resource to wait on. + * name: 'tuningJobs/my-tuningJob/operations/my-operation', + * // The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * timeout: 'placeholder-value', + * }); + * 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. + */ + wait( + params: Params$Resource$Tuningjobs$Operations$Wait, + options: StreamMethodOptions + ): Promise>; + wait( + params?: Params$Resource$Tuningjobs$Operations$Wait, + options?: MethodOptions + ): Promise>; + wait( + params: Params$Resource$Tuningjobs$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Tuningjobs$Operations$Wait, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Tuningjobs$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Tuningjobs$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Tuningjobs$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tuningjobs$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:wait').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$Tuningjobs$Operations$Cancel extends StandardParameters { @@ -188229,6 +205299,16 @@ export namespace aiplatform_v1 { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Tuningjobs$Operations$Wait extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } export class Resource$V1 { context: APIRequestContext; @@ -188319,8 +205399,7 @@ export namespace aiplatform_v1 { evaluateDataset( params: Params$Resource$V1$Evaluatedataset, options: - | MethodOptions - | BodyResponseCallback, + MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; evaluateDataset( From 2b9dc7310c006dcda6dfdf18814f10128320483f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 2/7] fix(analytics): update the API --- discovery/analytics-v3.json | 7459 -------------- src/apis/analytics/v3.ts | 18783 ---------------------------------- 2 files changed, 26242 deletions(-) delete mode 100644 discovery/analytics-v3.json delete mode 100644 src/apis/analytics/v3.ts diff --git a/discovery/analytics-v3.json b/discovery/analytics-v3.json deleted file mode 100644 index 25dfacefaff..00000000000 --- a/discovery/analytics-v3.json +++ /dev/null @@ -1,7459 +0,0 @@ -{ - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/analytics": { - "description": "View and manage your Google Analytics data" - }, - "https://www.googleapis.com/auth/analytics.edit": { - "description": "Edit Google Analytics management entities" - }, - "https://www.googleapis.com/auth/analytics.manage.users": { - "description": "Manage Google Analytics Account users by email address" - }, - "https://www.googleapis.com/auth/analytics.manage.users.readonly": { - "description": "View Google Analytics user permissions" - }, - "https://www.googleapis.com/auth/analytics.provision": { - "description": "Create a new Google Analytics account along with its default property and view" - }, - "https://www.googleapis.com/auth/analytics.readonly": { - "description": "View your Google Analytics data" - }, - "https://www.googleapis.com/auth/analytics.user.deletion": { - "description": "Manage Google Analytics user deletion requests" - } - } - } - }, - "basePath": "/analytics/v3/", - "baseUrl": "https://www.googleapis.com/analytics/v3/", - "batchPath": "batch/analytics/v3", - "description": "Views and manages your Google Analytics data.", - "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/analytics/", - "etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/o_TVyaWurnALX6ZIQ952-U5m22Y\"", - "icons": { - "x16": "https://www.google.com/images/icons/product/analytics-16.png", - "x32": "https://www.google.com/images/icons/product/analytics-32.png" - }, - "id": "analytics:v3", - "kind": "discovery#restDescription", - "name": "analytics", - "ownerDomain": "google.com", - "ownerName": "Google", - "parameters": { - "alt": { - "default": "json", - "description": "Data format for the response.", - "enum": [ - "json" - ], - "enumDescriptions": [ - "Responses with Content-Type of application/json" - ], - "location": "query", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "location": "query", - "type": "string" - }, - "key": { - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", - "location": "query", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "location": "query", - "type": "string" - }, - "prettyPrint": { - "default": "false", - "description": "Returns response with indentations and line breaks.", - "location": "query", - "type": "boolean" - }, - "quotaUser": { - "description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.", - "location": "query", - "type": "string" - }, - "userIp": { - "description": "Deprecated. Please use quotaUser instead.", - "location": "query", - "type": "string" - } - }, - "protocol": "rest", - "resources": { - "data": { - "resources": { - "ga": { - "methods": { - "get": { - "description": "Returns Analytics data for a view (profile).", - "httpMethod": "GET", - "id": "analytics.data.ga.get", - "parameterOrder": [ - "ids", - "start-date", - "end-date", - "metrics" - ], - "parameters": { - "dimensions": { - "description": "A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'.", - "location": "query", - "pattern": "(ga:.+)?", - "type": "string" - }, - "end-date": { - "description": "End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday.", - "location": "query", - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", - "required": true, - "type": "string" - }, - "filters": { - "description": "A comma-separated list of dimension or metric filters to be applied to Analytics data.", - "location": "query", - "pattern": "ga:.+", - "type": "string" - }, - "ids": { - "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", - "location": "query", - "pattern": "ga:[0-9]+", - "required": true, - "type": "string" - }, - "include-empty-rows": { - "description": "The response will include empty rows if this parameter is set to true, the default is true", - "location": "query", - "type": "boolean" - }, - "max-results": { - "description": "The maximum number of entries to include in this feed.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "metrics": { - "description": "A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified.", - "location": "query", - "pattern": "ga:.+", - "required": true, - "type": "string" - }, - "output": { - "description": "The selected format for the response. Default format is JSON.", - "enum": [ - "dataTable", - "json" - ], - "enumDescriptions": [ - "Returns the response in Google Charts Data Table format. This is useful in creating visualization using Google Charts.", - "Returns the response in standard JSON format." - ], - "location": "query", - "type": "string" - }, - "samplingLevel": { - "description": "The desired sampling level.", - "enum": [ - "DEFAULT", - "FASTER", - "HIGHER_PRECISION" - ], - "enumDescriptions": [ - "Returns response with a sample size that balances speed and accuracy.", - "Returns a fast response with a smaller sample size.", - "Returns a more accurate response using a large sample size, but this may result in the response being slower." - ], - "location": "query", - "type": "string" - }, - "segment": { - "description": "An Analytics segment to be applied to data.", - "location": "query", - "type": "string" - }, - "sort": { - "description": "A comma-separated list of dimensions or metrics that determine the sort order for Analytics data.", - "location": "query", - "pattern": "(-)?ga:.+", - "type": "string" - }, - "start-date": { - "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.", - "location": "query", - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "data/ga", - "response": { - "$ref": "GaData" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "mcf": { - "methods": { - "get": { - "description": "Returns Analytics Multi-Channel Funnels data for a view (profile).", - "httpMethod": "GET", - "id": "analytics.data.mcf.get", - "parameterOrder": [ - "ids", - "start-date", - "end-date", - "metrics" - ], - "parameters": { - "dimensions": { - "description": "A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'.", - "location": "query", - "pattern": "(mcf:.+)?", - "type": "string" - }, - "end-date": { - "description": "End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.", - "location": "query", - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", - "required": true, - "type": "string" - }, - "filters": { - "description": "A comma-separated list of dimension or metric filters to be applied to the Analytics data.", - "location": "query", - "pattern": "mcf:.+", - "type": "string" - }, - "ids": { - "description": "Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", - "location": "query", - "pattern": "ga:[0-9]+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of entries to include in this feed.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "metrics": { - "description": "A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified.", - "location": "query", - "pattern": "mcf:.+", - "required": true, - "type": "string" - }, - "samplingLevel": { - "description": "The desired sampling level.", - "enum": [ - "DEFAULT", - "FASTER", - "HIGHER_PRECISION" - ], - "enumDescriptions": [ - "Returns response with a sample size that balances speed and accuracy.", - "Returns a fast response with a smaller sample size.", - "Returns a more accurate response using a large sample size, but this may result in the response being slower." - ], - "location": "query", - "type": "string" - }, - "sort": { - "description": "A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data.", - "location": "query", - "pattern": "(-)?mcf:.+", - "type": "string" - }, - "start-date": { - "description": "Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo.", - "location": "query", - "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "data/mcf", - "response": { - "$ref": "McfData" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "realtime": { - "methods": { - "get": { - "description": "Returns real time data for a view (profile).", - "httpMethod": "GET", - "id": "analytics.data.realtime.get", - "parameterOrder": [ - "ids", - "metrics" - ], - "parameters": { - "dimensions": { - "description": "A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'.", - "location": "query", - "pattern": "(ga:.+)|(rt:.+)", - "type": "string" - }, - "filters": { - "description": "A comma-separated list of dimension or metric filters to be applied to real time data.", - "location": "query", - "pattern": "(ga:.+)|(rt:.+)", - "type": "string" - }, - "ids": { - "description": "Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID.", - "location": "query", - "pattern": "ga:[0-9]+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of entries to include in this feed.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "metrics": { - "description": "A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified.", - "location": "query", - "pattern": "(ga:.+)|(rt:.+)", - "required": true, - "type": "string" - }, - "sort": { - "description": "A comma-separated list of dimensions or metrics that determine the sort order for real time data.", - "location": "query", - "pattern": "(-)?((ga:.+)|(rt:.+))", - "type": "string" - } - }, - "path": "data/realtime", - "response": { - "$ref": "RealtimeData" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - } - } - }, - "management": { - "resources": { - "accountSummaries": { - "methods": { - "list": { - "description": "Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.accountSummaries.list", - "parameters": { - "max-results": { - "description": "The maximum number of account summaries to include in this response, where the largest acceptable value is 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/accountSummaries", - "response": { - "$ref": "AccountSummaries" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "accountUserLinks": { - "methods": { - "delete": { - "description": "Removes a user from the given account.", - "httpMethod": "DELETE", - "id": "analytics.management.accountUserLinks.delete", - "parameterOrder": [ - "accountId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/entityUserLinks/{linkId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "insert": { - "description": "Adds a new user to the given account.", - "httpMethod": "POST", - "id": "analytics.management.accountUserLinks.insert", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/entityUserLinks", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "list": { - "description": "Lists account-user links for a given account.", - "httpMethod": "GET", - "id": "analytics.management.accountUserLinks.list", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve the user links for.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of account-user links to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/accounts/{accountId}/entityUserLinks", - "response": { - "$ref": "EntityUserLinks" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "update": { - "description": "Updates permissions for an existing user on the given account.", - "httpMethod": "PUT", - "id": "analytics.management.accountUserLinks.update", - "parameterOrder": [ - "accountId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to update the account-user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to update the account-user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/entityUserLinks/{linkId}", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - } - } - }, - "accounts": { - "methods": { - "list": { - "description": "Lists all accounts to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.accounts.list", - "parameters": { - "max-results": { - "description": "The maximum number of accounts to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/accounts", - "response": { - "$ref": "Accounts" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "clientId": { - "methods": { - "hashClientId": { - "description": "Hashes the given Client ID.", - "httpMethod": "POST", - "id": "analytics.management.clientId.hashClientId", - "path": "management/clientId:hashClientId", - "request": { - "$ref": "HashClientIdRequest" - }, - "response": { - "$ref": "HashClientIdResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "customDataSources": { - "methods": { - "list": { - "description": "List custom data sources to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.customDataSources.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account Id for the custom data sources to retrieve.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of custom data sources to include in this response.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "start-index": { - "description": "A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property Id for the custom data sources to retrieve.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources", - "response": { - "$ref": "CustomDataSources" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "customDimensions": { - "methods": { - "get": { - "description": "Get a custom dimension to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.customDimensions.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDimensionId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom dimension to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "customDimensionId": { - "description": "The ID of the custom dimension to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimension to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}", - "response": { - "$ref": "CustomDimension" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new custom dimension.", - "httpMethod": "POST", - "id": "analytics.management.customDimensions.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom dimension to create.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimension to create.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions", - "request": { - "$ref": "CustomDimension" - }, - "response": { - "$ref": "CustomDimension" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists custom dimensions to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.customDimensions.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom dimensions to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of custom dimensions to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimensions to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions", - "response": { - "$ref": "CustomDimensions" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing custom dimension. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.customDimensions.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDimensionId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - }, - "customDimensionId": { - "description": "Custom dimension ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - }, - "ignoreCustomDataSourceLinks": { - "default": "false", - "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.", - "location": "query", - "type": "boolean" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}", - "request": { - "$ref": "CustomDimension" - }, - "response": { - "$ref": "CustomDimension" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing custom dimension.", - "httpMethod": "PUT", - "id": "analytics.management.customDimensions.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDimensionId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - }, - "customDimensionId": { - "description": "Custom dimension ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - }, - "ignoreCustomDataSourceLinks": { - "default": "false", - "description": "Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set.", - "location": "query", - "type": "boolean" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimension to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}", - "request": { - "$ref": "CustomDimension" - }, - "response": { - "$ref": "CustomDimension" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "customMetrics": { - "methods": { - "get": { - "description": "Get a custom metric to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.customMetrics.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customMetricId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom metric to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "customMetricId": { - "description": "The ID of the custom metric to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID for the custom metric to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", - "response": { - "$ref": "CustomMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new custom metric.", - "httpMethod": "POST", - "id": "analytics.management.customMetrics.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom metric to create.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID for the custom dimension to create.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics", - "request": { - "$ref": "CustomMetric" - }, - "response": { - "$ref": "CustomMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists custom metrics to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.customMetrics.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom metrics to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of custom metrics to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID for the custom metrics to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics", - "response": { - "$ref": "CustomMetrics" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing custom metric. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.customMetrics.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customMetricId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - }, - "customMetricId": { - "description": "Custom metric ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - }, - "ignoreCustomDataSourceLinks": { - "default": "false", - "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.", - "location": "query", - "type": "boolean" - }, - "webPropertyId": { - "description": "Web property ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", - "request": { - "$ref": "CustomMetric" - }, - "response": { - "$ref": "CustomMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing custom metric.", - "httpMethod": "PUT", - "id": "analytics.management.customMetrics.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customMetricId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - }, - "customMetricId": { - "description": "Custom metric ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - }, - "ignoreCustomDataSourceLinks": { - "default": "false", - "description": "Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set.", - "location": "query", - "type": "boolean" - }, - "webPropertyId": { - "description": "Web property ID for the custom metric to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}", - "request": { - "$ref": "CustomMetric" - }, - "response": { - "$ref": "CustomMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "experiments": { - "methods": { - "delete": { - "description": "Delete an experiment.", - "httpMethod": "DELETE", - "id": "analytics.management.experiments.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "experimentId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the experiment belongs", - "location": "path", - "required": true, - "type": "string" - }, - "experimentId": { - "description": "ID of the experiment to delete", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to which the experiment belongs", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to which the experiment belongs", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Returns an experiment to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.experiments.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "experimentId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve the experiment for.", - "location": "path", - "required": true, - "type": "string" - }, - "experimentId": { - "description": "Experiment ID to retrieve the experiment for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to retrieve the experiment for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the experiment for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", - "response": { - "$ref": "Experiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new experiment.", - "httpMethod": "POST", - "id": "analytics.management.experiments.insert", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the experiment for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to create the experiment for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to create the experiment for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments", - "request": { - "$ref": "Experiment" - }, - "response": { - "$ref": "Experiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists experiments to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.experiments.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve experiments for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of experiments to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "profileId": { - "description": "View (Profile) ID to retrieve experiments for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID to retrieve experiments for.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments", - "response": { - "$ref": "Experiments" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Update an existing experiment. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.experiments.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "experimentId" - ], - "parameters": { - "accountId": { - "description": "Account ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "experimentId": { - "description": "Experiment ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", - "request": { - "$ref": "Experiment" - }, - "response": { - "$ref": "Experiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Update an existing experiment.", - "httpMethod": "PUT", - "id": "analytics.management.experiments.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "experimentId" - ], - "parameters": { - "accountId": { - "description": "Account ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "experimentId": { - "description": "Experiment ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the experiment to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}", - "request": { - "$ref": "Experiment" - }, - "response": { - "$ref": "Experiment" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "filters": { - "methods": { - "delete": { - "description": "Delete a filter.", - "httpMethod": "DELETE", - "id": "analytics.management.filters.delete", - "parameterOrder": [ - "accountId", - "filterId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the filter for.", - "location": "path", - "required": true, - "type": "string" - }, - "filterId": { - "description": "ID of the filter to be deleted.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/filters/{filterId}", - "response": { - "$ref": "Filter" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Returns filters to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.filters.get", - "parameterOrder": [ - "accountId", - "filterId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve filters for.", - "location": "path", - "required": true, - "type": "string" - }, - "filterId": { - "description": "Filter ID to retrieve filters for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/filters/{filterId}", - "response": { - "$ref": "Filter" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new filter.", - "httpMethod": "POST", - "id": "analytics.management.filters.insert", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create filter for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/filters", - "request": { - "$ref": "Filter" - }, - "response": { - "$ref": "Filter" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists all filters for an account", - "httpMethod": "GET", - "id": "analytics.management.filters.list", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve filters for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of filters to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/accounts/{accountId}/filters", - "response": { - "$ref": "Filters" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing filter. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.filters.patch", - "parameterOrder": [ - "accountId", - "filterId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the filter belongs.", - "location": "path", - "required": true, - "type": "string" - }, - "filterId": { - "description": "ID of the filter to be updated.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/filters/{filterId}", - "request": { - "$ref": "Filter" - }, - "response": { - "$ref": "Filter" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing filter.", - "httpMethod": "PUT", - "id": "analytics.management.filters.update", - "parameterOrder": [ - "accountId", - "filterId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the filter belongs.", - "location": "path", - "required": true, - "type": "string" - }, - "filterId": { - "description": "ID of the filter to be updated.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/filters/{filterId}", - "request": { - "$ref": "Filter" - }, - "response": { - "$ref": "Filter" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "goals": { - "methods": { - "get": { - "description": "Gets a goal to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.goals.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "goalId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve the goal for.", - "location": "path", - "required": true, - "type": "string" - }, - "goalId": { - "description": "Goal ID to retrieve the goal for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to retrieve the goal for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the goal for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", - "response": { - "$ref": "Goal" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new goal.", - "httpMethod": "POST", - "id": "analytics.management.goals.insert", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the goal for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to create the goal for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to create the goal for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals", - "request": { - "$ref": "Goal" - }, - "response": { - "$ref": "Goal" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists goals to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.goals.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of goals to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "profileId": { - "description": "View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to.", - "location": "path", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals", - "response": { - "$ref": "Goals" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing goal. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.goals.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "goalId" - ], - "parameters": { - "accountId": { - "description": "Account ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - }, - "goalId": { - "description": "Index of the goal to be updated.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", - "request": { - "$ref": "Goal" - }, - "response": { - "$ref": "Goal" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing goal.", - "httpMethod": "PUT", - "id": "analytics.management.goals.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "goalId" - ], - "parameters": { - "accountId": { - "description": "Account ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - }, - "goalId": { - "description": "Index of the goal to be updated.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to update the goal.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}", - "request": { - "$ref": "Goal" - }, - "response": { - "$ref": "Goal" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "profileFilterLinks": { - "methods": { - "delete": { - "description": "Delete a profile filter link.", - "httpMethod": "DELETE", - "id": "analytics.management.profileFilterLinks.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the profile filter link belongs.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "linkId": { - "description": "ID of the profile filter link to delete.", - "location": "path", - "pattern": "\\d+:\\d+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "Profile ID to which the filter link belongs.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id to which the profile filter link belongs.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Returns a single profile filter link.", - "httpMethod": "GET", - "id": "analytics.management.profileFilterLinks.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve profile filter link for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "linkId": { - "description": "ID of the profile filter link.", - "location": "path", - "pattern": "\\d+:\\d+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "Profile ID to retrieve filter link for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id to retrieve profile filter link for.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", - "response": { - "$ref": "ProfileFilterLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new profile filter link.", - "httpMethod": "POST", - "id": "analytics.management.profileFilterLinks.insert", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create profile filter link for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "Profile ID to create filter link for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id to create profile filter link for.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks", - "request": { - "$ref": "ProfileFilterLink" - }, - "response": { - "$ref": "ProfileFilterLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists all profile filter links for a profile.", - "httpMethod": "GET", - "id": "analytics.management.profileFilterLinks.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve profile filter links for.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of profile filter links to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "profileId": { - "description": "Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.", - "location": "path", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks", - "response": { - "$ref": "ProfileFilterLinks" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Update an existing profile filter link. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.profileFilterLinks.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which profile filter link belongs.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "linkId": { - "description": "ID of the profile filter link to be updated.", - "location": "path", - "pattern": "\\d+:\\d+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "Profile ID to which filter link belongs", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id to which profile filter link belongs", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", - "request": { - "$ref": "ProfileFilterLink" - }, - "response": { - "$ref": "ProfileFilterLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Update an existing profile filter link.", - "httpMethod": "PUT", - "id": "analytics.management.profileFilterLinks.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which profile filter link belongs.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "linkId": { - "description": "ID of the profile filter link to be updated.", - "location": "path", - "pattern": "\\d+:\\d+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "Profile ID to which filter link belongs", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id to which profile filter link belongs", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}", - "request": { - "$ref": "ProfileFilterLink" - }, - "response": { - "$ref": "ProfileFilterLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "profileUserLinks": { - "methods": { - "delete": { - "description": "Removes a user from the given view (profile).", - "httpMethod": "DELETE", - "id": "analytics.management.profileUserLinks.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "insert": { - "description": "Adds a new user to the given view (profile).", - "httpMethod": "POST", - "id": "analytics.management.profileUserLinks.insert", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "list": { - "description": "Lists profile-user links for a given view (profile).", - "httpMethod": "GET", - "id": "analytics.management.profileUserLinks.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID which the given view (profile) belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of profile-user links to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "profileId": { - "description": "View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to.", - "location": "path", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks", - "response": { - "$ref": "EntityUserLinks" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "update": { - "description": "Updates permissions for an existing user on the given view (profile).", - "httpMethod": "PUT", - "id": "analytics.management.profileUserLinks.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to update the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to update the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile ID) to update the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to update the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - } - } - }, - "profiles": { - "methods": { - "delete": { - "description": "Deletes a view (profile).", - "httpMethod": "DELETE", - "id": "analytics.management.profiles.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the view (profile) for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "ID of the view (profile) to be deleted.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to delete the view (profile) for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Gets a view (profile) to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.profiles.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve the view (profile) for.", - "location": "path", - "pattern": "[0-9]+", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to retrieve the view (profile) for.", - "location": "path", - "pattern": "[0-9]+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the view (profile) for.", - "location": "path", - "pattern": "UA-[0-9]+-[0-9]+", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", - "response": { - "$ref": "Profile" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new view (profile).", - "httpMethod": "POST", - "id": "analytics.management.profiles.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the view (profile) for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to create the view (profile) for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles", - "request": { - "$ref": "Profile" - }, - "response": { - "$ref": "Profile" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists views (profiles) to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.profiles.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of views (profiles) to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles", - "response": { - "$ref": "Profiles" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing view (profile). This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.profiles.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the view (profile) belongs", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "ID of the view (profile) to be updated.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to which the view (profile) belongs", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", - "request": { - "$ref": "Profile" - }, - "response": { - "$ref": "Profile" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing view (profile).", - "httpMethod": "PUT", - "id": "analytics.management.profiles.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the view (profile) belongs", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "ID of the view (profile) to be updated.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to which the view (profile) belongs", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}", - "request": { - "$ref": "Profile" - }, - "response": { - "$ref": "Profile" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "remarketingAudience": { - "methods": { - "delete": { - "description": "Delete a remarketing audience.", - "httpMethod": "DELETE", - "id": "analytics.management.remarketingAudience.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "remarketingAudienceId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the remarketing audience belongs.", - "location": "path", - "required": true, - "type": "string" - }, - "remarketingAudienceId": { - "description": "The ID of the remarketing audience to delete.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to which the remarketing audience belongs.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Gets a remarketing audience to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.remarketingAudience.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "remarketingAudienceId" - ], - "parameters": { - "accountId": { - "description": "The account ID of the remarketing audience to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "remarketingAudienceId": { - "description": "The ID of the remarketing audience to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "The web property ID of the remarketing audience to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", - "response": { - "$ref": "RemarketingAudience" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Creates a new remarketing audience.", - "httpMethod": "POST", - "id": "analytics.management.remarketingAudience.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "The account ID for which to create the remarketing audience.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID for which to create the remarketing audience.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences", - "request": { - "$ref": "RemarketingAudience" - }, - "response": { - "$ref": "RemarketingAudience" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists remarketing audiences to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.remarketingAudience.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "The account ID of the remarketing audiences to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of remarketing audiences to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "type": { - "default": "all", - "location": "query", - "type": "string" - }, - "webPropertyId": { - "description": "The web property ID of the remarketing audiences to retrieve.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences", - "response": { - "$ref": "RemarketingAudiences" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing remarketing audience. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.remarketingAudience.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "remarketingAudienceId" - ], - "parameters": { - "accountId": { - "description": "The account ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - }, - "remarketingAudienceId": { - "description": "The ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "The web property ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", - "request": { - "$ref": "RemarketingAudience" - }, - "response": { - "$ref": "RemarketingAudience" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing remarketing audience.", - "httpMethod": "PUT", - "id": "analytics.management.remarketingAudience.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "remarketingAudienceId" - ], - "parameters": { - "accountId": { - "description": "The account ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - }, - "remarketingAudienceId": { - "description": "The ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "The web property ID of the remarketing audience to update.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}", - "request": { - "$ref": "RemarketingAudience" - }, - "response": { - "$ref": "RemarketingAudience" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "segments": { - "methods": { - "list": { - "description": "Lists segments to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.segments.list", - "parameters": { - "max-results": { - "description": "The maximum number of segments to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/segments", - "response": { - "$ref": "Segments" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "unsampledReports": { - "methods": { - "delete": { - "description": "Deletes an unsampled report.", - "httpMethod": "DELETE", - "id": "analytics.management.unsampledReports.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "unsampledReportId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to delete the unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "unsampledReportId": { - "description": "ID of the unsampled report to be deleted.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to delete the unsampled reports for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Returns a single unsampled report.", - "httpMethod": "GET", - "id": "analytics.management.unsampledReports.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId", - "unsampledReportId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to retrieve unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "unsampledReportId": { - "description": "ID of the unsampled report to retrieve.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve unsampled reports for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}", - "response": { - "$ref": "UnsampledReport" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new unsampled report.", - "httpMethod": "POST", - "id": "analytics.management.unsampledReports.insert", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to create the unsampled report for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to create the unsampled report for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports", - "request": { - "$ref": "UnsampledReport" - }, - "response": { - "$ref": "UnsampledReport" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists unsampled reports to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.unsampledReports.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "profileId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of unsampled reports to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "profileId": { - "description": "View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported.", - "location": "path", - "required": true, - "type": "string" - }, - "start-index": { - "description": "An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports", - "response": { - "$ref": "UnsampledReports" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - }, - "uploads": { - "methods": { - "deleteUploadData": { - "description": "Delete data associated with a previous upload.", - "httpMethod": "POST", - "id": "analytics.management.uploads.deleteUploadData", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDataSourceId" - ], - "parameters": { - "accountId": { - "description": "Account Id for the uploads to be deleted.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "customDataSourceId": { - "description": "Custom data source Id for the uploads to be deleted.", - "location": "path", - "pattern": ".{22}", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id for the uploads to be deleted.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData", - "request": { - "$ref": "AnalyticsDataimportDeleteUploadDataRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "List uploads to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.uploads.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDataSourceId", - "uploadId" - ], - "parameters": { - "accountId": { - "description": "Account Id for the upload to retrieve.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "customDataSourceId": { - "description": "Custom data source Id for upload to retrieve.", - "location": "path", - "pattern": ".{22}", - "required": true, - "type": "string" - }, - "uploadId": { - "description": "Upload Id to retrieve.", - "location": "path", - "pattern": ".{22}", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property Id for the upload to retrieve.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}", - "response": { - "$ref": "Upload" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "list": { - "description": "List uploads to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.uploads.list", - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDataSourceId" - ], - "parameters": { - "accountId": { - "description": "Account Id for the uploads to retrieve.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "customDataSourceId": { - "description": "Custom data source Id for uploads to retrieve.", - "location": "path", - "pattern": ".{22}", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of uploads to include in this response.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "start-index": { - "description": "A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property Id for the uploads to retrieve.", - "location": "path", - "pattern": "UA-(\\d+)-(\\d+)", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads", - "response": { - "$ref": "Uploads" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "uploadData": { - "description": "Upload data for a custom data source.", - "httpMethod": "POST", - "id": "analytics.management.uploads.uploadData", - "mediaUpload": { - "accept": [ - "application/octet-stream" - ], - "maxSize": "1GB", - "protocols": { - "resumable": { - "multipart": true, - "path": "/resumable/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads" - }, - "simple": { - "multipart": true, - "path": "/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads" - } - } - }, - "parameterOrder": [ - "accountId", - "webPropertyId", - "customDataSourceId" - ], - "parameters": { - "accountId": { - "description": "Account Id associated with the upload.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "customDataSourceId": { - "description": "Custom data source Id to which the data being uploaded belongs.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property UA-string associated with the upload.", - "location": "path", - "pattern": "UA-\\d+-\\d+", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads", - "response": { - "$ref": "Upload" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit" - ], - "supportsMediaUpload": true - } - } - }, - "webPropertyAdWordsLinks": { - "methods": { - "delete": { - "description": "Deletes a web property-Google Ads link.", - "httpMethod": "DELETE", - "id": "analytics.management.webPropertyAdWordsLinks.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "webPropertyAdWordsLinkId" - ], - "parameters": { - "accountId": { - "description": "ID of the account which the given web property belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyAdWordsLinkId": { - "description": "Web property Google Ads link ID.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to delete the Google Ads link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "get": { - "description": "Returns a web property-Google Ads link to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.webPropertyAdWordsLinks.get", - "parameterOrder": [ - "accountId", - "webPropertyId", - "webPropertyAdWordsLinkId" - ], - "parameters": { - "accountId": { - "description": "ID of the account which the given web property belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyAdWordsLinkId": { - "description": "Web property-Google Ads link ID.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the Google Ads link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", - "response": { - "$ref": "EntityAdWordsLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Creates a webProperty-Google Ads link.", - "httpMethod": "POST", - "id": "analytics.management.webPropertyAdWordsLinks.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "ID of the Google Analytics account to create the link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to create the link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks", - "request": { - "$ref": "EntityAdWordsLink" - }, - "response": { - "$ref": "EntityAdWordsLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists webProperty-Google Ads links for a given web property.", - "httpMethod": "GET", - "id": "analytics.management.webPropertyAdWordsLinks.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "ID of the account which the given web property belongs to.", - "location": "path", - "pattern": "\\d+", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of webProperty-Google Ads links to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the Google Ads links for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks", - "response": { - "$ref": "EntityAdWordsLinks" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing webProperty-Google Ads link. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.webPropertyAdWordsLinks.patch", - "parameterOrder": [ - "accountId", - "webPropertyId", - "webPropertyAdWordsLinkId" - ], - "parameters": { - "accountId": { - "description": "ID of the account which the given web property belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyAdWordsLinkId": { - "description": "Web property-Google Ads link ID.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the Google Ads link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", - "request": { - "$ref": "EntityAdWordsLink" - }, - "response": { - "$ref": "EntityAdWordsLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing webProperty-Google Ads link.", - "httpMethod": "PUT", - "id": "analytics.management.webPropertyAdWordsLinks.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "webPropertyAdWordsLinkId" - ], - "parameters": { - "accountId": { - "description": "ID of the account which the given web property belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyAdWordsLinkId": { - "description": "Web property-Google Ads link ID.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to retrieve the Google Ads link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}", - "request": { - "$ref": "EntityAdWordsLink" - }, - "response": { - "$ref": "EntityAdWordsLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "webproperties": { - "methods": { - "get": { - "description": "Gets a web property to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.webproperties.get", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve the web property for.", - "location": "path", - "pattern": "[0-9]+", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "ID to retrieve the web property for.", - "location": "path", - "pattern": "UA-[0-9]+-[0-9]+", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}", - "response": { - "$ref": "Webproperty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "insert": { - "description": "Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile.", - "httpMethod": "POST", - "id": "analytics.management.webproperties.insert", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the web property for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties", - "request": { - "$ref": "Webproperty" - }, - "response": { - "$ref": "Webproperty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "list": { - "description": "Lists web properties to which the user has access.", - "httpMethod": "GET", - "id": "analytics.management.webproperties.list", - "parameterOrder": [ - "accountId" - ], - "parameters": { - "accountId": { - "description": "Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of web properties to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - } - }, - "path": "management/accounts/{accountId}/webproperties", - "response": { - "$ref": "Webproperties" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - }, - "patch": { - "description": "Updates an existing web property. This method supports patch semantics.", - "httpMethod": "PATCH", - "id": "analytics.management.webproperties.patch", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the web property belongs", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}", - "request": { - "$ref": "Webproperty" - }, - "response": { - "$ref": "Webproperty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, - "update": { - "description": "Updates an existing web property.", - "httpMethod": "PUT", - "id": "analytics.management.webproperties.update", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID to which the web property belongs", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}", - "request": { - "$ref": "Webproperty" - }, - "response": { - "$ref": "Webproperty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - } - } - }, - "webpropertyUserLinks": { - "methods": { - "delete": { - "description": "Removes a user from the given web property.", - "httpMethod": "DELETE", - "id": "analytics.management.webpropertyUserLinks.delete", - "parameterOrder": [ - "accountId", - "webPropertyId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to delete the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}", - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "insert": { - "description": "Adds a new user to the given web property.", - "httpMethod": "POST", - "id": "analytics.management.webpropertyUserLinks.insert", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to create the user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "list": { - "description": "Lists webProperty-user links for a given web property.", - "httpMethod": "GET", - "id": "analytics.management.webpropertyUserLinks.list", - "parameterOrder": [ - "accountId", - "webPropertyId" - ], - "parameters": { - "accountId": { - "description": "Account ID which the given web property belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "max-results": { - "description": "The maximum number of webProperty-user Links to include in this response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "start-index": { - "description": "An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter.", - "format": "int32", - "location": "query", - "minimum": "1", - "type": "integer" - }, - "webPropertyId": { - "description": "Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks", - "response": { - "$ref": "EntityUserLinks" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "update": { - "description": "Updates permissions for an existing user on the given web property.", - "httpMethod": "PUT", - "id": "analytics.management.webpropertyUserLinks.update", - "parameterOrder": [ - "accountId", - "webPropertyId", - "linkId" - ], - "parameters": { - "accountId": { - "description": "Account ID to update the account-user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "linkId": { - "description": "Link ID to update the account-user link for.", - "location": "path", - "required": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to update the account-user link for.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}", - "request": { - "$ref": "EntityUserLink" - }, - "response": { - "$ref": "EntityUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - } - } - } - } - }, - "metadata": { - "resources": { - "columns": { - "methods": { - "list": { - "description": "Lists all columns for a report type", - "httpMethod": "GET", - "id": "analytics.metadata.columns.list", - "parameterOrder": [ - "reportType" - ], - "parameters": { - "reportType": { - "description": "Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API", - "location": "path", - "pattern": "ga", - "required": true, - "type": "string" - } - }, - "path": "metadata/{reportType}/columns", - "response": { - "$ref": "Columns" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics", - "https://www.googleapis.com/auth/analytics.edit", - "https://www.googleapis.com/auth/analytics.readonly" - ] - } - } - } - } - }, - "provisioning": { - "methods": { - "createAccountTicket": { - "description": "Creates an account ticket.", - "httpMethod": "POST", - "id": "analytics.provisioning.createAccountTicket", - "path": "provisioning/createAccountTicket", - "request": { - "$ref": "AccountTicket" - }, - "response": { - "$ref": "AccountTicket" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.provision" - ] - }, - "createAccountTree": { - "description": "Provision account.", - "httpMethod": "POST", - "id": "analytics.provisioning.createAccountTree", - "path": "provisioning/createAccountTree", - "request": { - "$ref": "AccountTreeRequest" - }, - "response": { - "$ref": "AccountTreeResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.provision" - ] - } - } - }, - "userDeletion": { - "resources": { - "userDeletionRequest": { - "methods": { - "upsert": { - "description": "Insert or update a user deletion requests.", - "httpMethod": "POST", - "id": "analytics.userDeletion.userDeletionRequest.upsert", - "path": "userDeletion/userDeletionRequests:upsert", - "request": { - "$ref": "UserDeletionRequest" - }, - "response": { - "$ref": "UserDeletionRequest" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.user.deletion" - ] - } - } - } - } - } - }, - "revision": "20190807", - "rootUrl": "https://analytics.googleapis.com/", - "schemas": { - "Account": { - "description": "JSON template for Analytics account entry.", - "id": "Account", - "properties": { - "childLink": { - "description": "Child link for an account entry. Points to the list of web properties for this account.", - "properties": { - "href": { - "description": "Link to the list of web properties for this account.", - "type": "string" - }, - "type": { - "default": "analytics#webproperties", - "description": "Type of the child link. Its value is \"analytics#webproperties\".", - "type": "string" - } - }, - "type": "object" - }, - "created": { - "description": "Time the account was created.", - "format": "date-time", - "type": "string" - }, - "id": { - "description": "Account ID.", - "type": "string" - }, - "kind": { - "default": "analytics#account", - "description": "Resource type for Analytics account.", - "type": "string" - }, - "name": { - "description": "Account name.", - "type": "string" - }, - "permissions": { - "description": "Permissions the user has for this account.", - "properties": { - "effective": { - "description": "All the permissions that the user has for this account. These include any implied permissions (e.g., EDIT implies VIEW).", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "selfLink": { - "description": "Link for this account.", - "type": "string" - }, - "starred": { - "description": "Indicates whether this account is starred or not.", - "type": "boolean" - }, - "updated": { - "description": "Time the account was last modified.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "AccountRef": { - "description": "JSON template for a linked account.", - "id": "AccountRef", - "properties": { - "href": { - "description": "Link for this account.", - "type": "string" - }, - "id": { - "description": "Account ID.", - "type": "string" - }, - "kind": { - "default": "analytics#accountRef", - "description": "Analytics account reference.", - "type": "string" - }, - "name": { - "description": "Account name.", - "type": "string" - } - }, - "type": "object" - }, - "AccountSummaries": { - "description": "An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary.", - "id": "AccountSummaries", - "properties": { - "items": { - "description": "A list of AccountSummaries.", - "items": { - "$ref": "AccountSummary" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#accountSummaries", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this AccountSummary collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this AccountSummary collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "AccountSummary": { - "description": "JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles.", - "id": "AccountSummary", - "properties": { - "id": { - "description": "Account ID.", - "type": "string" - }, - "kind": { - "default": "analytics#accountSummary", - "description": "Resource type for Analytics AccountSummary.", - "type": "string" - }, - "name": { - "description": "Account name.", - "type": "string" - }, - "starred": { - "description": "Indicates whether this account is starred or not.", - "type": "boolean" - }, - "webProperties": { - "description": "List of web properties under this account.", - "items": { - "$ref": "WebPropertySummary" - }, - "type": "array" - } - }, - "type": "object" - }, - "AccountTicket": { - "description": "JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile.", - "id": "AccountTicket", - "properties": { - "account": { - "$ref": "Account", - "description": "Account for this ticket." - }, - "id": { - "description": "Account ticket ID used to access the account ticket.", - "type": "string" - }, - "kind": { - "default": "analytics#accountTicket", - "description": "Resource type for account ticket.", - "type": "string" - }, - "profile": { - "$ref": "Profile", - "description": "View (Profile) for the account." - }, - "redirectUri": { - "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL.", - "type": "string" - }, - "webproperty": { - "$ref": "Webproperty", - "description": "Web property for the account." - } - }, - "type": "object" - }, - "AccountTreeRequest": { - "description": "JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields.", - "id": "AccountTreeRequest", - "properties": { - "accountName": { - "annotations": { - "required": [ - "analytics.provisioning.createAccountTree" - ] - }, - "type": "string" - }, - "kind": { - "default": "analytics#accountTreeRequest", - "description": "Resource type for account ticket.", - "type": "string" - }, - "profileName": { - "annotations": { - "required": [ - "analytics.provisioning.createAccountTree" - ] - }, - "type": "string" - }, - "timezone": { - "annotations": { - "required": [ - "analytics.provisioning.createAccountTree" - ] - }, - "type": "string" - }, - "webpropertyName": { - "annotations": { - "required": [ - "analytics.provisioning.createAccountTree" - ] - }, - "type": "string" - }, - "websiteUrl": { - "annotations": { - "required": [ - "analytics.provisioning.createAccountTree" - ] - }, - "type": "string" - } - }, - "type": "object" - }, - "AccountTreeResponse": { - "description": "JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile).", - "id": "AccountTreeResponse", - "properties": { - "account": { - "$ref": "Account", - "description": "The account created." - }, - "kind": { - "default": "analytics#accountTreeResponse", - "description": "Resource type for account ticket.", - "type": "string" - }, - "profile": { - "$ref": "Profile", - "description": "View (Profile) for the account." - }, - "webproperty": { - "$ref": "Webproperty", - "description": "Web property for the account." - } - }, - "type": "object" - }, - "Accounts": { - "description": "An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account.", - "id": "Accounts", - "properties": { - "items": { - "description": "A list of accounts.", - "items": { - "$ref": "Account" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#accounts", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Next link for this account collection.", - "type": "string" - }, - "previousLink": { - "description": "Previous link for this account collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "AdWordsAccount": { - "description": "JSON template for an Google Ads account.", - "id": "AdWordsAccount", - "properties": { - "autoTaggingEnabled": { - "description": "True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation.", - "type": "boolean" - }, - "customerId": { - "annotations": { - "required": [ - "analytics.management.webPropertyAdWordsLinks.insert", - "analytics.management.webPropertyAdWordsLinks.update" - ] - }, - "description": "Customer ID. This field is required when creating a Google Ads link.", - "type": "string" - }, - "kind": { - "default": "analytics#adWordsAccount", - "description": "Resource type for Google Ads account.", - "type": "string" - } - }, - "type": "object" - }, - "AnalyticsDataimportDeleteUploadDataRequest": { - "description": "Request template for the delete upload data request.", - "id": "AnalyticsDataimportDeleteUploadDataRequest", - "properties": { - "customDataImportUids": { - "description": "A list of upload UIDs.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Column": { - "description": "JSON template for a metadata column.", - "id": "Column", - "properties": { - "attributes": { - "additionalProperties": { - "description": "The name of the attribute.", - "type": "string" - }, - "description": "Map of attribute name and value for this column.", - "type": "object" - }, - "id": { - "description": "Column id.", - "type": "string" - }, - "kind": { - "default": "analytics#column", - "description": "Resource type for Analytics column.", - "type": "string" - } - }, - "type": "object" - }, - "Columns": { - "description": "Lists columns (dimensions and metrics) for a particular report type.", - "id": "Columns", - "properties": { - "attributeNames": { - "description": "List of attributes names returned by columns.", - "items": { - "type": "string" - }, - "type": "array" - }, - "etag": { - "description": "Etag of collection. This etag can be compared with the last response etag to check if response has changed.", - "type": "string" - }, - "items": { - "description": "List of columns for a report type.", - "items": { - "$ref": "Column" - }, - "type": "array" - }, - "kind": { - "default": "analytics#columns", - "description": "Collection type.", - "type": "string" - }, - "totalResults": { - "description": "Total number of columns returned in the response.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CustomDataSource": { - "description": "JSON template for an Analytics custom data source.", - "id": "CustomDataSource", - "properties": { - "accountId": { - "description": "Account ID to which this custom data source belongs.", - "type": "string" - }, - "childLink": { - "properties": { - "href": { - "description": "Link to the list of daily uploads for this custom data source. Link to the list of uploads for this custom data source.", - "type": "string" - }, - "type": { - "description": "Value is \"analytics#dailyUploads\". Value is \"analytics#uploads\".", - "type": "string" - } - }, - "type": "object" - }, - "created": { - "description": "Time this custom data source was created.", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Description of custom data source.", - "type": "string" - }, - "id": { - "description": "Custom data source ID.", - "type": "string" - }, - "importBehavior": { - "type": "string" - }, - "kind": { - "default": "analytics#customDataSource", - "description": "Resource type for Analytics custom data source.", - "type": "string" - }, - "name": { - "description": "Name of this custom data source.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for this custom data source. Points to the web property to which this custom data source belongs.", - "properties": { - "href": { - "description": "Link to the web property to which this custom data source belongs.", - "type": "string" - }, - "type": { - "default": "analytics#webproperty", - "description": "Value is \"analytics#webproperty\".", - "type": "string" - } - }, - "type": "object" - }, - "profilesLinked": { - "description": "IDs of views (profiles) linked to the custom data source.", - "items": { - "type": "string" - }, - "type": "array" - }, - "schema": { - "description": "Collection of schema headers of the custom data source.", - "items": { - "type": "string" - }, - "type": "array" - }, - "selfLink": { - "description": "Link for this Analytics custom data source.", - "type": "string" - }, - "type": { - "description": "Type of the custom data source.", - "type": "string" - }, - "updated": { - "description": "Time this custom data source was last modified.", - "format": "date-time", - "type": "string" - }, - "uploadType": { - "description": "Upload type of the custom data source.", - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY to which this custom data source belongs.", - "type": "string" - } - }, - "type": "object" - }, - "CustomDataSources": { - "description": "Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source.", - "id": "CustomDataSources", - "properties": { - "items": { - "description": "Collection of custom data sources.", - "items": { - "$ref": "CustomDataSource" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#customDataSources", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this custom data source collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this custom data source collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "CustomDimension": { - "description": "JSON template for Analytics Custom Dimension.", - "id": "CustomDimension", - "properties": { - "accountId": { - "description": "Account ID.", - "type": "string" - }, - "active": { - "description": "Boolean indicating whether the custom dimension is active.", - "type": "boolean" - }, - "created": { - "description": "Time the custom dimension was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Custom dimension ID.", - "type": "string" - }, - "index": { - "description": "Index of the custom dimension.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "kind": { - "default": "analytics#customDimension", - "description": "Kind value for a custom dimension. Set to \"analytics#customDimension\". It is a read-only field.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Name of the custom dimension.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for the custom dimension. Points to the property to which the custom dimension belongs.", - "properties": { - "href": { - "description": "Link to the property to which the custom dimension belongs.", - "type": "string" - }, - "type": { - "default": "analytics#webproperty", - "description": "Type of the parent link. Set to \"analytics#webproperty\".", - "type": "string" - } - }, - "type": "object" - }, - "scope": { - "description": "Scope of the custom dimension: HIT, SESSION, USER or PRODUCT.", - "type": "string" - }, - "selfLink": { - "description": "Link for the custom dimension", - "readOnly": true, - "type": "string" - }, - "updated": { - "description": "Time the custom dimension was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "webPropertyId": { - "description": "Property ID.", - "type": "string" - } - }, - "type": "object" - }, - "CustomDimensions": { - "description": "A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension.", - "id": "CustomDimensions", - "properties": { - "items": { - "description": "Collection of custom dimensions.", - "items": { - "$ref": "CustomDimension" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#customDimensions", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this custom dimension collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this custom dimension collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "CustomMetric": { - "description": "JSON template for Analytics Custom Metric.", - "id": "CustomMetric", - "properties": { - "accountId": { - "description": "Account ID.", - "type": "string" - }, - "active": { - "description": "Boolean indicating whether the custom metric is active.", - "type": "boolean" - }, - "created": { - "description": "Time the custom metric was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Custom metric ID.", - "type": "string" - }, - "index": { - "description": "Index of the custom metric.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "kind": { - "default": "analytics#customMetric", - "description": "Kind value for a custom metric. Set to \"analytics#customMetric\". It is a read-only field.", - "readOnly": true, - "type": "string" - }, - "max_value": { - "description": "Max value of custom metric.", - "type": "string" - }, - "min_value": { - "description": "Min value of custom metric.", - "type": "string" - }, - "name": { - "description": "Name of the custom metric.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for the custom metric. Points to the property to which the custom metric belongs.", - "properties": { - "href": { - "description": "Link to the property to which the custom metric belongs.", - "type": "string" - }, - "type": { - "default": "analytics#webproperty", - "description": "Type of the parent link. Set to \"analytics#webproperty\".", - "type": "string" - } - }, - "type": "object" - }, - "scope": { - "description": "Scope of the custom metric: HIT or PRODUCT.", - "type": "string" - }, - "selfLink": { - "description": "Link for the custom metric", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "Data type of custom metric.", - "type": "string" - }, - "updated": { - "description": "Time the custom metric was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "webPropertyId": { - "description": "Property ID.", - "type": "string" - } - }, - "type": "object" - }, - "CustomMetrics": { - "description": "A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric.", - "id": "CustomMetrics", - "properties": { - "items": { - "description": "Collection of custom metrics.", - "items": { - "$ref": "CustomMetric" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#customMetrics", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this custom metric collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this custom metric collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "EntityAdWordsLink": { - "description": "JSON template for Analytics Entity Google Ads Link.", - "id": "EntityAdWordsLink", - "properties": { - "adWordsAccounts": { - "annotations": { - "required": [ - "analytics.management.webPropertyAdWordsLinks.insert", - "analytics.management.webPropertyAdWordsLinks.update" - ] - }, - "description": "A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty.", - "items": { - "$ref": "AdWordsAccount" - }, - "type": "array" - }, - "entity": { - "description": "Web property being linked.", - "properties": { - "webPropertyRef": { - "$ref": "WebPropertyRef" - } - }, - "type": "object" - }, - "id": { - "description": "Entity Google Ads link ID", - "type": "string" - }, - "kind": { - "default": "analytics#entityAdWordsLink", - "description": "Resource type for entity Google Ads link.", - "type": "string" - }, - "name": { - "annotations": { - "required": [ - "analytics.management.webPropertyAdWordsLinks.insert", - "analytics.management.webPropertyAdWordsLinks.update" - ] - }, - "description": "Name of the link. This field is required when creating a Google Ads link.", - "type": "string" - }, - "profileIds": { - "description": "IDs of linked Views (Profiles) represented as strings.", - "items": { - "type": "string" - }, - "type": "array" - }, - "selfLink": { - "description": "URL link for this Google Analytics - Google Ads link.", - "type": "string" - } - }, - "type": "object" - }, - "EntityAdWordsLinks": { - "description": "An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link.", - "id": "EntityAdWordsLinks", - "properties": { - "items": { - "description": "A list of entity Google Ads links.", - "items": { - "$ref": "EntityAdWordsLink" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#entityAdWordsLinks", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Next link for this Google Ads link collection.", - "type": "string" - }, - "previousLink": { - "description": "Previous link for this Google Ads link collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "EntityUserLink": { - "description": "JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity.", - "id": "EntityUserLink", - "properties": { - "entity": { - "description": "Entity for this link. It can be an account, a web property, or a view (profile).", - "properties": { - "accountRef": { - "$ref": "AccountRef", - "description": "Account for this link." - }, - "profileRef": { - "$ref": "ProfileRef", - "description": "View (Profile) for this link." - }, - "webPropertyRef": { - "$ref": "WebPropertyRef", - "description": "Web property for this link." - } - }, - "type": "object" - }, - "id": { - "description": "Entity user link ID", - "type": "string" - }, - "kind": { - "default": "analytics#entityUserLink", - "description": "Resource type for entity user link.", - "type": "string" - }, - "permissions": { - "description": "Permissions the user has for this entity.", - "properties": { - "effective": { - "description": "Effective permissions represent all the permissions that a user has for this entity. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent entity. Effective permissions are read-only.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "local": { - "description": "Permissions that a user has been assigned at this very level. Does not include any implied or inherited permissions. Local permissions are modifiable.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "selfLink": { - "description": "Self link for this resource.", - "type": "string" - }, - "userRef": { - "$ref": "UserRef", - "description": "User reference." - } - }, - "type": "object" - }, - "EntityUserLinks": { - "description": "An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link.", - "id": "EntityUserLinks", - "properties": { - "items": { - "description": "A list of entity user links.", - "items": { - "$ref": "EntityUserLink" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#entityUserLinks", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Next link for this account collection.", - "type": "string" - }, - "previousLink": { - "description": "Previous link for this account collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Experiment": { - "description": "JSON template for Analytics experiment resource.", - "id": "Experiment", - "properties": { - "accountId": { - "description": "Account ID to which this experiment belongs. This field is read-only.", - "type": "string" - }, - "created": { - "description": "Time the experiment was created. This field is read-only.", - "format": "date-time", - "type": "string" - }, - "description": { - "description": "Notes about this experiment.", - "type": "string" - }, - "editableInGaUi": { - "description": "If true, the end user will be able to edit the experiment via the Google Analytics user interface.", - "type": "boolean" - }, - "endTime": { - "description": "The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only.", - "format": "date-time", - "type": "string" - }, - "equalWeighting": { - "description": "Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED.", - "type": "boolean" - }, - "id": { - "annotations": { - "required": [ - "analytics.management.experiments.patch", - "analytics.management.experiments.update" - ] - }, - "description": "Experiment ID. Required for patch and update. Disallowed for create.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this experiment belongs. This field is read-only.", - "type": "string" - }, - "kind": { - "default": "analytics#experiment", - "description": "Resource type for an Analytics experiment. This field is read-only.", - "type": "string" - }, - "minimumExperimentLengthInDays": { - "description": "An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.", - "format": "int32", - "type": "integer" - }, - "name": { - "annotations": { - "required": [ - "analytics.management.experiments.insert", - "analytics.management.experiments.update" - ] - }, - "description": "Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment.", - "type": "string" - }, - "objectiveMetric": { - "description": "The metric that the experiment is optimizing. Valid values: \"ga:goal(n)Completions\", \"ga:adsenseAdsClicks\", \"ga:adsenseAdsViewed\", \"ga:adsenseRevenue\", \"ga:bounces\", \"ga:pageviews\", \"ga:sessionDuration\", \"ga:transactions\", \"ga:transactionRevenue\". This field is required if status is \"RUNNING\" and servingFramework is one of \"REDIRECT\" or \"API\".", - "type": "string" - }, - "optimizationType": { - "description": "Whether the objectiveMetric should be minimized or maximized. Possible values: \"MAXIMUM\", \"MINIMUM\". Optional--defaults to \"MAXIMUM\". Cannot be specified without objectiveMetric. Cannot be modified when status is \"RUNNING\" or \"ENDED\".", - "type": "string" - }, - "parentLink": { - "description": "Parent link for an experiment. Points to the view (profile) to which this experiment belongs.", - "properties": { - "href": { - "description": "Link to the view (profile) to which this experiment belongs. This field is read-only.", - "type": "string" - }, - "type": { - "default": "analytics#profile", - "description": "Value is \"analytics#profile\". This field is read-only.", - "type": "string" - } - }, - "type": "object" - }, - "profileId": { - "description": "View (Profile) ID to which this experiment belongs. This field is read-only.", - "type": "string" - }, - "reasonExperimentEnded": { - "description": "Why the experiment ended. Possible values: \"STOPPED_BY_USER\", \"WINNER_FOUND\", \"EXPERIMENT_EXPIRED\", \"ENDED_WITH_NO_WINNER\", \"GOAL_OBJECTIVE_CHANGED\". \"ENDED_WITH_NO_WINNER\" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only.", - "type": "string" - }, - "rewriteVariationUrlsAsOriginal": { - "description": "Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED.", - "type": "boolean" - }, - "selfLink": { - "description": "Link for this experiment. This field is read-only.", - "type": "string" - }, - "servingFramework": { - "description": "The framework used to serve the experiment variations and evaluate the results. One of: \n- REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results.\n- API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation.\n- EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results.", - "type": "string" - }, - "snippet": { - "description": "The snippet of code to include on the control page(s). This field is read-only.", - "type": "string" - }, - "startTime": { - "description": "The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only.", - "format": "date-time", - "type": "string" - }, - "status": { - "annotations": { - "required": [ - "analytics.management.experiments.insert", - "analytics.management.experiments.update" - ] - }, - "description": "Experiment status. Possible values: \"DRAFT\", \"READY_TO_RUN\", \"RUNNING\", \"ENDED\". Experiments can be created in the \"DRAFT\", \"READY_TO_RUN\" or \"RUNNING\" state. This field is required when creating an experiment.", - "type": "string" - }, - "trafficCoverage": { - "description": "A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED.", - "format": "double", - "type": "number" - }, - "updated": { - "description": "Time the experiment was last modified. This field is read-only.", - "format": "date-time", - "type": "string" - }, - "variations": { - "description": "Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING.", - "items": { - "properties": { - "name": { - "annotations": { - "required": [ - "analytics.management.experiments.insert", - "analytics.management.experiments.update" - ] - }, - "description": "The name of the variation. This field is required when creating an experiment. This field may not be changed for an experiment whose status is ENDED.", - "type": "string" - }, - "status": { - "description": "Status of the variation. Possible values: \"ACTIVE\", \"INACTIVE\". INACTIVE variations are not served. This field may not be changed for an experiment whose status is ENDED.", - "type": "string" - }, - "url": { - "description": "The URL of the variation. This field may not be changed for an experiment whose status is RUNNING or ENDED.", - "type": "string" - }, - "weight": { - "description": "Weight that this variation should receive. Only present if the experiment is running. This field is read-only.", - "format": "double", - "type": "number" - }, - "won": { - "description": "True if the experiment has ended and this variation performed (statistically) significantly better than the original. This field is read-only.", - "type": "boolean" - } - }, - "type": "object" - }, - "type": "array" - }, - "webPropertyId": { - "description": "Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only.", - "type": "string" - }, - "winnerConfidenceLevel": { - "description": "A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED.", - "format": "double", - "type": "number" - }, - "winnerFound": { - "description": "Boolean specifying whether a winner has been found for this experiment. This field is read-only.", - "type": "boolean" - } - }, - "type": "object" - }, - "Experiments": { - "description": "An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment.", - "id": "Experiments", - "properties": { - "items": { - "description": "A list of experiments.", - "items": { - "$ref": "Experiment" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#experiments", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this experiment collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this experiment collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of resources in the result.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "Filter": { - "description": "JSON template for an Analytics account filter.", - "id": "Filter", - "properties": { - "accountId": { - "description": "Account ID to which this filter belongs.", - "type": "string" - }, - "advancedDetails": { - "description": "Details for the filter of the type ADVANCED.", - "properties": { - "caseSensitive": { - "description": "Indicates if the filter expressions are case sensitive.", - "type": "boolean" - }, - "extractA": { - "description": "Expression to extract from field A.", - "type": "string" - }, - "extractB": { - "description": "Expression to extract from field B.", - "type": "string" - }, - "fieldA": { - "description": "Field A.", - "type": "string" - }, - "fieldAIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - }, - "fieldARequired": { - "description": "Indicates if field A is required to match.", - "type": "boolean" - }, - "fieldB": { - "description": "Field B.", - "type": "string" - }, - "fieldBIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - }, - "fieldBRequired": { - "description": "Indicates if field B is required to match.", - "type": "boolean" - }, - "outputConstructor": { - "description": "Expression used to construct the output value.", - "type": "string" - }, - "outputToField": { - "description": "Output field.", - "type": "string" - }, - "outputToFieldIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - }, - "overrideOutputField": { - "description": "Indicates if the existing value of the output field, if any, should be overridden by the output expression.", - "type": "boolean" - } - }, - "type": "object" - }, - "created": { - "description": "Time this filter was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "excludeDetails": { - "$ref": "FilterExpression", - "description": "Details for the filter of the type EXCLUDE." - }, - "id": { - "description": "Filter ID.", - "type": "string" - }, - "includeDetails": { - "$ref": "FilterExpression", - "description": "Details for the filter of the type INCLUDE." - }, - "kind": { - "default": "analytics#filter", - "description": "Resource type for Analytics filter.", - "readOnly": true, - "type": "string" - }, - "lowercaseDetails": { - "description": "Details for the filter of the type LOWER.", - "properties": { - "field": { - "description": "Field to use in the filter.", - "type": "string" - }, - "fieldIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "name": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.filters.update" - ] - }, - "description": "Name of this filter.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for this filter. Points to the account to which this filter belongs.", - "properties": { - "href": { - "description": "Link to the account to which this filter belongs.", - "type": "string" - }, - "type": { - "default": "analytics#account", - "description": "Value is \"analytics#account\".", - "type": "string" - } - }, - "type": "object" - }, - "searchAndReplaceDetails": { - "description": "Details for the filter of the type SEARCH_AND_REPLACE.", - "properties": { - "caseSensitive": { - "description": "Determines if the filter is case sensitive.", - "type": "boolean" - }, - "field": { - "description": "Field to use in the filter.", - "type": "string" - }, - "fieldIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - }, - "replaceString": { - "description": "Term to replace the search term with.", - "type": "string" - }, - "searchString": { - "description": "Term to search.", - "type": "string" - } - }, - "type": "object" - }, - "selfLink": { - "description": "Link for this filter.", - "readOnly": true, - "type": "string" - }, - "type": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.filters.update" - ] - }, - "description": "Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED.", - "type": "string" - }, - "updated": { - "description": "Time this filter was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "uppercaseDetails": { - "description": "Details for the filter of the type UPPER.", - "properties": { - "field": { - "description": "Field to use in the filter.", - "type": "string" - }, - "fieldIndex": { - "description": "The Index of the custom dimension. Required if field is a CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - } - }, - "type": "object" - }, - "FilterExpression": { - "description": "JSON template for an Analytics filter expression.", - "id": "FilterExpression", - "properties": { - "caseSensitive": { - "description": "Determines if the filter is case sensitive.", - "type": "boolean" - }, - "expressionValue": { - "description": "Filter expression value", - "type": "string" - }, - "field": { - "description": "Field to filter. Possible values: \n- Content and Traffic \n- PAGE_REQUEST_URI, \n- PAGE_HOSTNAME, \n- PAGE_TITLE, \n- REFERRAL, \n- COST_DATA_URI (Campaign target URL), \n- HIT_TYPE, \n- INTERNAL_SEARCH_TERM, \n- INTERNAL_SEARCH_TYPE, \n- SOURCE_PROPERTY_TRACKING_ID, \n- Campaign or AdGroup \n- CAMPAIGN_SOURCE, \n- CAMPAIGN_MEDIUM, \n- CAMPAIGN_NAME, \n- CAMPAIGN_AD_GROUP, \n- CAMPAIGN_TERM, \n- CAMPAIGN_CONTENT, \n- CAMPAIGN_CODE, \n- CAMPAIGN_REFERRAL_PATH, \n- E-Commerce \n- TRANSACTION_COUNTRY, \n- TRANSACTION_REGION, \n- TRANSACTION_CITY, \n- TRANSACTION_AFFILIATION (Store or order location), \n- ITEM_NAME, \n- ITEM_CODE, \n- ITEM_VARIATION, \n- TRANSACTION_ID, \n- TRANSACTION_CURRENCY_CODE, \n- PRODUCT_ACTION_TYPE, \n- Audience/Users \n- BROWSER, \n- BROWSER_VERSION, \n- BROWSER_SIZE, \n- PLATFORM, \n- PLATFORM_VERSION, \n- LANGUAGE, \n- SCREEN_RESOLUTION, \n- SCREEN_COLORS, \n- JAVA_ENABLED (Boolean Field), \n- FLASH_VERSION, \n- GEO_SPEED (Connection speed), \n- VISITOR_TYPE, \n- GEO_ORGANIZATION (ISP organization), \n- GEO_DOMAIN, \n- GEO_IP_ADDRESS, \n- GEO_IP_VERSION, \n- Location \n- GEO_COUNTRY, \n- GEO_REGION, \n- GEO_CITY, \n- Event \n- EVENT_CATEGORY, \n- EVENT_ACTION, \n- EVENT_LABEL, \n- Other \n- CUSTOM_FIELD_1, \n- CUSTOM_FIELD_2, \n- USER_DEFINED_VALUE, \n- Application \n- APP_ID, \n- APP_INSTALLER_ID, \n- APP_NAME, \n- APP_VERSION, \n- SCREEN, \n- IS_APP (Boolean Field), \n- IS_FATAL_EXCEPTION (Boolean Field), \n- EXCEPTION_DESCRIPTION, \n- Mobile device \n- IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), \n- IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), \n- DEVICE_CATEGORY, \n- MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), \n- MOBILE_HAS_NFC_SUPPORT (Boolean Field), \n- MOBILE_HAS_CELLULAR_RADIO (Boolean Field), \n- MOBILE_HAS_WIFI_SUPPORT (Boolean Field), \n- MOBILE_BRAND_NAME, \n- MOBILE_MODEL_NAME, \n- MOBILE_MARKETING_NAME, \n- MOBILE_POINTING_METHOD, \n- Social \n- SOCIAL_NETWORK, \n- SOCIAL_ACTION, \n- SOCIAL_ACTION_TARGET, \n- Custom dimension \n- CUSTOM_DIMENSION (See accompanying field index),", - "type": "string" - }, - "fieldIndex": { - "description": "The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#filterExpression", - "description": "Kind value for filter expression", - "type": "string" - }, - "matchType": { - "description": "Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES.", - "type": "string" - } - }, - "type": "object" - }, - "FilterRef": { - "description": "JSON template for a profile filter link.", - "id": "FilterRef", - "properties": { - "accountId": { - "description": "Account ID to which this filter belongs.", - "readOnly": true, - "type": "string" - }, - "href": { - "description": "Link for this filter.", - "type": "string" - }, - "id": { - "annotations": { - "required": [ - "analytics.management.profileFilterLinks.insert" - ] - }, - "description": "Filter ID.", - "type": "string" - }, - "kind": { - "default": "analytics#filterRef", - "description": "Kind value for filter reference.", - "type": "string" - }, - "name": { - "description": "Name of this filter.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "Filters": { - "description": "A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter.", - "id": "Filters", - "properties": { - "items": { - "description": "A list of filters.", - "items": { - "$ref": "Filter" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#filters", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this filter collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this filter collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "GaData": { - "description": "Analytics data for a given view (profile).", - "id": "GaData", - "properties": { - "columnHeaders": { - "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.", - "items": { - "properties": { - "columnType": { - "description": "Column Type. Either DIMENSION or METRIC.", - "type": "string" - }, - "dataType": { - "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.", - "type": "string" - }, - "name": { - "description": "Column name.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "containsSampledData": { - "description": "Determines if Analytics data contains samples.", - "type": "boolean" - }, - "dataLastRefreshed": { - "description": "The last refreshed time in seconds for Analytics data.", - "format": "int64", - "type": "string" - }, - "dataTable": { - "properties": { - "cols": { - "items": { - "properties": { - "id": { - "type": "string" - }, - "label": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "rows": { - "items": { - "properties": { - "c": { - "items": { - "properties": { - "v": { - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "type": "array" - } - }, - "type": "object" - }, - "id": { - "description": "Unique ID for this data response.", - "type": "string" - }, - "itemsPerPage": { - "description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#gaData", - "description": "Resource type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this Analytics data query.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this Analytics data query.", - "type": "string" - }, - "profileInfo": { - "description": "Information for the view (profile), for which the Analytics data was requested.", - "properties": { - "accountId": { - "description": "Account ID to which this view (profile) belongs.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this view (profile) belongs.", - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID.", - "type": "string" - }, - "profileName": { - "description": "View (Profile) name.", - "type": "string" - }, - "tableId": { - "description": "Table ID for view (profile).", - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to which this view (profile) belongs.", - "type": "string" - } - }, - "type": "object" - }, - "query": { - "description": "Analytics data request query parameters.", - "properties": { - "dimensions": { - "description": "List of analytics dimensions.", - "type": "string" - }, - "end-date": { - "description": "End date.", - "type": "string" - }, - "filters": { - "description": "Comma-separated list of dimension or metric filters.", - "type": "string" - }, - "ids": { - "description": "Unique table ID.", - "type": "string" - }, - "max-results": { - "description": "Maximum results per page.", - "format": "int32", - "type": "integer" - }, - "metrics": { - "description": "List of analytics metrics.", - "items": { - "type": "string" - }, - "type": "array" - }, - "samplingLevel": { - "description": "Desired sampling level", - "type": "string" - }, - "segment": { - "description": "Analytics advanced segment.", - "type": "string" - }, - "sort": { - "description": "List of dimensions or metrics based on which Analytics data is sorted.", - "items": { - "type": "string" - }, - "type": "array" - }, - "start-date": { - "description": "Start date.", - "type": "string" - }, - "start-index": { - "description": "Start index.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "rows": { - "description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.", - "items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "array" - }, - "sampleSize": { - "description": "The number of samples used to calculate the result.", - "format": "int64", - "type": "string" - }, - "sampleSpace": { - "description": "Total size of the sample space from which the samples were selected.", - "format": "int64", - "type": "string" - }, - "selfLink": { - "description": "Link to this page.", - "type": "string" - }, - "totalResults": { - "description": "The total number of rows for the query, regardless of the number of rows in the response.", - "format": "int32", - "type": "integer" - }, - "totalsForAllResults": { - "additionalProperties": { - "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.", - "type": "string" - }, - "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.", - "type": "object" - } - }, - "type": "object" - }, - "Goal": { - "description": "JSON template for Analytics goal resource.", - "id": "Goal", - "properties": { - "accountId": { - "description": "Account ID to which this goal belongs.", - "type": "string" - }, - "active": { - "description": "Determines whether this goal is active.", - "type": "boolean" - }, - "created": { - "description": "Time this goal was created.", - "format": "date-time", - "type": "string" - }, - "eventDetails": { - "description": "Details for the goal of the type EVENT.", - "properties": { - "eventConditions": { - "description": "List of event conditions.", - "items": { - "properties": { - "comparisonType": { - "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN or EQUAL.", - "type": "string" - }, - "comparisonValue": { - "description": "Value used for this comparison.", - "format": "int64", - "type": "string" - }, - "expression": { - "description": "Expression used for this match.", - "type": "string" - }, - "matchType": { - "description": "Type of the match to be performed. Possible values are REGEXP, BEGINS_WITH, or EXACT.", - "type": "string" - }, - "type": { - "description": "Type of this event condition. Possible values are CATEGORY, ACTION, LABEL, or VALUE.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "useEventValue": { - "description": "Determines if the event value should be used as the value for this goal.", - "type": "boolean" - } - }, - "type": "object" - }, - "id": { - "description": "Goal ID.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this goal belongs.", - "type": "string" - }, - "kind": { - "default": "analytics#goal", - "description": "Resource type for an Analytics goal.", - "type": "string" - }, - "name": { - "description": "Goal name.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for a goal. Points to the view (profile) to which this goal belongs.", - "properties": { - "href": { - "description": "Link to the view (profile) to which this goal belongs.", - "type": "string" - }, - "type": { - "default": "analytics#profile", - "description": "Value is \"analytics#profile\".", - "type": "string" - } - }, - "type": "object" - }, - "profileId": { - "description": "View (Profile) ID to which this goal belongs.", - "type": "string" - }, - "selfLink": { - "description": "Link for this goal.", - "type": "string" - }, - "type": { - "description": "Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT.", - "type": "string" - }, - "updated": { - "description": "Time this goal was last modified.", - "format": "date-time", - "type": "string" - }, - "urlDestinationDetails": { - "description": "Details for the goal of the type URL_DESTINATION.", - "properties": { - "caseSensitive": { - "description": "Determines if the goal URL must exactly match the capitalization of visited URLs.", - "type": "boolean" - }, - "firstStepRequired": { - "description": "Determines if the first step in this goal is required.", - "type": "boolean" - }, - "matchType": { - "description": "Match type for the goal URL. Possible values are HEAD, EXACT, or REGEX.", - "type": "string" - }, - "steps": { - "description": "List of steps configured for this goal funnel.", - "items": { - "properties": { - "name": { - "description": "Step name.", - "type": "string" - }, - "number": { - "description": "Step number.", - "format": "int32", - "type": "integer" - }, - "url": { - "description": "URL for this step.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "url": { - "description": "URL for this goal.", - "type": "string" - } - }, - "type": "object" - }, - "value": { - "description": "Goal value.", - "format": "float", - "type": "number" - }, - "visitNumPagesDetails": { - "description": "Details for the goal of the type VISIT_NUM_PAGES.", - "properties": { - "comparisonType": { - "description": "Type of comparison. Possible values are LESS_THAN, GREATER_THAN, or EQUAL.", - "type": "string" - }, - "comparisonValue": { - "description": "Value used for this comparison.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "visitTimeOnSiteDetails": { - "description": "Details for the goal of the type VISIT_TIME_ON_SITE.", - "properties": { - "comparisonType": { - "description": "Type of comparison. Possible values are LESS_THAN or GREATER_THAN.", - "type": "string" - }, - "comparisonValue": { - "description": "Value used for this comparison.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "webPropertyId": { - "description": "Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY.", - "type": "string" - } - }, - "type": "object" - }, - "Goals": { - "description": "A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal.", - "id": "Goals", - "properties": { - "items": { - "description": "A list of goals.", - "items": { - "$ref": "Goal" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#goals", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this goal collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this goal collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of resources in the result.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "HashClientIdRequest": { - "description": "JSON template for a hash Client Id request resource.", - "id": "HashClientIdRequest", - "properties": { - "clientId": { - "type": "string" - }, - "kind": { - "default": "analytics#hashClientIdRequest", - "type": "string" - }, - "webPropertyId": { - "type": "string" - } - }, - "type": "object" - }, - "HashClientIdResponse": { - "description": "JSON template for a hash Client Id response resource.", - "id": "HashClientIdResponse", - "properties": { - "clientId": { - "type": "string" - }, - "hashedClientId": { - "type": "string" - }, - "kind": { - "default": "analytics#hashClientIdResponse", - "type": "string" - }, - "webPropertyId": { - "type": "string" - } - }, - "type": "object" - }, - "IncludeConditions": { - "description": "JSON template for an Analytics Remarketing Include Conditions.", - "id": "IncludeConditions", - "properties": { - "daysToLookBack": { - "description": "The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience.", - "format": "int32", - "type": "integer" - }, - "isSmartList": { - "description": "Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577", - "type": "boolean" - }, - "kind": { - "default": "analytics#includeConditions", - "description": "Resource type for include conditions.", - "type": "string" - }, - "membershipDurationDays": { - "description": "Number of days (in the range 1 to 540) a user remains in the audience.", - "format": "int32", - "type": "integer" - }, - "segment": { - "description": "The segment condition that will cause a user to be added to an audience.", - "type": "string" - } - }, - "type": "object" - }, - "LinkedForeignAccount": { - "description": "JSON template for an Analytics Remarketing Audience Foreign Link.", - "id": "LinkedForeignAccount", - "properties": { - "accountId": { - "description": "Account ID to which this linked foreign account belongs.", - "type": "string" - }, - "eligibleForSearch": { - "description": "Boolean indicating whether this is eligible for search.", - "readOnly": true, - "type": "boolean" - }, - "id": { - "description": "Entity ad account link ID.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this linked foreign account belongs.", - "readOnly": true, - "type": "string" - }, - "kind": { - "default": "analytics#linkedForeignAccount", - "description": "Resource type for linked foreign account.", - "type": "string" - }, - "linkedAccountId": { - "description": "The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX.", - "type": "string" - }, - "remarketingAudienceId": { - "description": "Remarketing audience ID to which this linked foreign account belongs.", - "type": "string" - }, - "status": { - "description": "The status of this foreign account link.", - "type": "string" - }, - "type": { - "description": "The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`.", - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs.", - "type": "string" - } - }, - "type": "object" - }, - "McfData": { - "description": "Multi-Channel Funnels data for a given view (profile).", - "id": "McfData", - "properties": { - "columnHeaders": { - "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.", - "items": { - "properties": { - "columnType": { - "description": "Column Type. Either DIMENSION or METRIC.", - "type": "string" - }, - "dataType": { - "description": "Data type. Dimension and metric values data types such as INTEGER, DOUBLE, CURRENCY, MCF_SEQUENCE etc.", - "type": "string" - }, - "name": { - "description": "Column name.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "containsSampledData": { - "description": "Determines if the Analytics data contains sampled data.", - "type": "boolean" - }, - "id": { - "description": "Unique ID for this data response.", - "type": "string" - }, - "itemsPerPage": { - "description": "The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#mcfData", - "description": "Resource type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this Analytics data query.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this Analytics data query.", - "type": "string" - }, - "profileInfo": { - "description": "Information for the view (profile), for which the Analytics data was requested.", - "properties": { - "accountId": { - "description": "Account ID to which this view (profile) belongs.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this view (profile) belongs.", - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID.", - "type": "string" - }, - "profileName": { - "description": "View (Profile) name.", - "type": "string" - }, - "tableId": { - "description": "Table ID for view (profile).", - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to which this view (profile) belongs.", - "type": "string" - } - }, - "type": "object" - }, - "query": { - "description": "Analytics data request query parameters.", - "properties": { - "dimensions": { - "description": "List of analytics dimensions.", - "type": "string" - }, - "end-date": { - "description": "End date.", - "type": "string" - }, - "filters": { - "description": "Comma-separated list of dimension or metric filters.", - "type": "string" - }, - "ids": { - "description": "Unique table ID.", - "type": "string" - }, - "max-results": { - "description": "Maximum results per page.", - "format": "int32", - "type": "integer" - }, - "metrics": { - "description": "List of analytics metrics.", - "items": { - "type": "string" - }, - "type": "array" - }, - "samplingLevel": { - "description": "Desired sampling level", - "type": "string" - }, - "segment": { - "description": "Analytics advanced segment.", - "type": "string" - }, - "sort": { - "description": "List of dimensions or metrics based on which Analytics data is sorted.", - "items": { - "type": "string" - }, - "type": "array" - }, - "start-date": { - "description": "Start date.", - "type": "string" - }, - "start-index": { - "description": "Start index.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "rows": { - "description": "Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.", - "items": { - "items": { - "description": "A union object representing a dimension or metric value. Only one of \"primitiveValue\" or \"conversionPathValue\" attribute will be populated.", - "properties": { - "conversionPathValue": { - "description": "A conversion path dimension value, containing a list of interactions with their attributes.", - "items": { - "properties": { - "interactionType": { - "description": "Type of an interaction on conversion path. Such as CLICK, IMPRESSION etc.", - "type": "string" - }, - "nodeValue": { - "description": "Node value of an interaction on conversion path. Such as source, medium etc.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "primitiveValue": { - "description": "A primitive dimension value. A primitive metric value.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "type": "array" - }, - "sampleSize": { - "description": "The number of samples used to calculate the result.", - "format": "int64", - "type": "string" - }, - "sampleSpace": { - "description": "Total size of the sample space from which the samples were selected.", - "format": "int64", - "type": "string" - }, - "selfLink": { - "description": "Link to this page.", - "type": "string" - }, - "totalResults": { - "description": "The total number of rows for the query, regardless of the number of rows in the response.", - "format": "int32", - "type": "integer" - }, - "totalsForAllResults": { - "additionalProperties": { - "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.", - "type": "string" - }, - "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.", - "type": "object" - } - }, - "type": "object" - }, - "Profile": { - "description": "JSON template for an Analytics view (profile).", - "id": "Profile", - "properties": { - "accountId": { - "description": "Account ID to which this view (profile) belongs.", - "type": "string" - }, - "botFilteringEnabled": { - "description": "Indicates whether bot filtering is enabled for this view (profile).", - "type": "boolean" - }, - "childLink": { - "description": "Child link for this view (profile). Points to the list of goals for this view (profile).", - "properties": { - "href": { - "description": "Link to the list of goals for this view (profile).", - "type": "string" - }, - "type": { - "default": "analytics#goals", - "description": "Value is \"analytics#goals\".", - "type": "string" - } - }, - "type": "object" - }, - "created": { - "description": "Time this view (profile) was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "currency": { - "description": "The currency type associated with this view (profile), defaults to USD. The supported values are:\nUSD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL", - "type": "string" - }, - "defaultPage": { - "description": "Default page for this view (profile).", - "type": "string" - }, - "eCommerceTracking": { - "description": "Indicates whether ecommerce tracking is enabled for this view (profile).", - "type": "boolean" - }, - "enhancedECommerceTracking": { - "description": "Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled.", - "type": "boolean" - }, - "excludeQueryParameters": { - "description": "The query parameters that are excluded from this view (profile).", - "type": "string" - }, - "id": { - "description": "View (Profile) ID.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this view (profile) belongs.", - "readOnly": true, - "type": "string" - }, - "kind": { - "default": "analytics#profile", - "description": "Resource type for Analytics view (profile).", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Name of this view (profile).", - "type": "string" - }, - "parentLink": { - "description": "Parent link for this view (profile). Points to the web property to which this view (profile) belongs.", - "properties": { - "href": { - "description": "Link to the web property to which this view (profile) belongs.", - "type": "string" - }, - "type": { - "default": "analytics#webproperty", - "description": "Value is \"analytics#webproperty\".", - "type": "string" - } - }, - "type": "object" - }, - "permissions": { - "description": "Permissions the user has for this view (profile).", - "properties": { - "effective": { - "description": "All the permissions that the user has for this view (profile). These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent web property.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "selfLink": { - "description": "Link for this view (profile).", - "readOnly": true, - "type": "string" - }, - "siteSearchCategoryParameters": { - "description": "Site search category parameters for this view (profile).", - "type": "string" - }, - "siteSearchQueryParameters": { - "description": "The site search query parameters for this view (profile).", - "type": "string" - }, - "starred": { - "description": "Indicates whether this view (profile) is starred or not.", - "type": "boolean" - }, - "stripSiteSearchCategoryParameters": { - "description": "Whether or not Analytics will strip search category parameters from the URLs in your reports.", - "type": "boolean" - }, - "stripSiteSearchQueryParameters": { - "description": "Whether or not Analytics will strip search query parameters from the URLs in your reports.", - "type": "boolean" - }, - "timezone": { - "description": "Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database.", - "type": "string" - }, - "type": { - "description": "View (Profile) type. Supported types: WEB or APP.", - "type": "string" - }, - "updated": { - "description": "Time this view (profile) was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.", - "readOnly": true, - "type": "string" - }, - "websiteUrl": { - "description": "Website URL for this view (profile).", - "type": "string" - } - }, - "type": "object" - }, - "ProfileFilterLink": { - "description": "JSON template for an Analytics profile filter link.", - "id": "ProfileFilterLink", - "properties": { - "filterRef": { - "$ref": "FilterRef", - "description": "Filter for this link." - }, - "id": { - "description": "Profile filter link ID.", - "type": "string" - }, - "kind": { - "default": "analytics#profileFilterLink", - "description": "Resource type for Analytics filter.", - "readOnly": true, - "type": "string" - }, - "profileRef": { - "$ref": "ProfileRef", - "description": "View (Profile) for this link." - }, - "rank": { - "description": "The rank of this profile filter link relative to the other filters linked to the same profile.\nFor readonly (i.e., list and get) operations, the rank always starts at 1.\nFor write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1.", - "format": "int32", - "type": "integer" - }, - "selfLink": { - "description": "Link for this profile filter link.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "ProfileFilterLinks": { - "description": "A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link.", - "id": "ProfileFilterLinks", - "properties": { - "items": { - "description": "A list of profile filter links.", - "items": { - "$ref": "ProfileFilterLink" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#profileFilterLinks", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this profile filter link collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this profile filter link collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "ProfileRef": { - "description": "JSON template for a linked view (profile).", - "id": "ProfileRef", - "properties": { - "accountId": { - "description": "Account ID to which this view (profile) belongs.", - "type": "string" - }, - "href": { - "description": "Link for this view (profile).", - "type": "string" - }, - "id": { - "description": "View (Profile) ID.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this view (profile) belongs.", - "type": "string" - }, - "kind": { - "default": "analytics#profileRef", - "description": "Analytics view (profile) reference.", - "type": "string" - }, - "name": { - "description": "Name of this view (profile).", - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs.", - "type": "string" - } - }, - "type": "object" - }, - "ProfileSummary": { - "description": "JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile.", - "id": "ProfileSummary", - "properties": { - "id": { - "description": "View (profile) ID.", - "type": "string" - }, - "kind": { - "default": "analytics#profileSummary", - "description": "Resource type for Analytics ProfileSummary.", - "type": "string" - }, - "name": { - "description": "View (profile) name.", - "type": "string" - }, - "starred": { - "description": "Indicates whether this view (profile) is starred or not.", - "type": "boolean" - }, - "type": { - "description": "View (Profile) type. Supported types: WEB or APP.", - "type": "string" - } - }, - "type": "object" - }, - "Profiles": { - "description": "A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile).", - "id": "Profiles", - "properties": { - "items": { - "description": "A list of views (profiles).", - "items": { - "$ref": "Profile" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#profiles", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this view (profile) collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this view (profile) collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "RealtimeData": { - "description": "Real time data for a given view (profile).", - "id": "RealtimeData", - "properties": { - "columnHeaders": { - "description": "Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request.", - "items": { - "properties": { - "columnType": { - "description": "Column Type. Either DIMENSION or METRIC.", - "type": "string" - }, - "dataType": { - "description": "Data type. Dimension column headers have only STRING as the data type. Metric column headers have data types for metric values such as INTEGER, DOUBLE, CURRENCY etc.", - "type": "string" - }, - "name": { - "description": "Column name.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "id": { - "description": "Unique ID for this data response.", - "type": "string" - }, - "kind": { - "default": "analytics#realtimeData", - "description": "Resource type.", - "type": "string" - }, - "profileInfo": { - "description": "Information for the view (profile), for which the real time data was requested.", - "properties": { - "accountId": { - "description": "Account ID to which this view (profile) belongs.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this view (profile) belongs.", - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID.", - "type": "string" - }, - "profileName": { - "description": "View (Profile) name.", - "type": "string" - }, - "tableId": { - "description": "Table ID for view (profile).", - "type": "string" - }, - "webPropertyId": { - "description": "Web Property ID to which this view (profile) belongs.", - "type": "string" - } - }, - "type": "object" - }, - "query": { - "description": "Real time data request query parameters.", - "properties": { - "dimensions": { - "description": "List of real time dimensions.", - "type": "string" - }, - "filters": { - "description": "Comma-separated list of dimension or metric filters.", - "type": "string" - }, - "ids": { - "description": "Unique table ID.", - "type": "string" - }, - "max-results": { - "description": "Maximum results per page.", - "format": "int32", - "type": "integer" - }, - "metrics": { - "description": "List of real time metrics.", - "items": { - "type": "string" - }, - "type": "array" - }, - "sort": { - "description": "List of dimensions or metrics based on which real time data is sorted.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "rows": { - "description": "Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request.", - "items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "array" - }, - "selfLink": { - "description": "Link to this page.", - "type": "string" - }, - "totalResults": { - "description": "The total number of rows for the query, regardless of the number of rows in the response.", - "format": "int32", - "type": "integer" - }, - "totalsForAllResults": { - "additionalProperties": { - "description": "Key-value pair for the total value of a metric. Key is the metric name and the value is the total value for that metric.", - "type": "string" - }, - "description": "Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request.", - "type": "object" - } - }, - "type": "object" - }, - "RemarketingAudience": { - "description": "JSON template for an Analytics remarketing audience.", - "id": "RemarketingAudience", - "properties": { - "accountId": { - "description": "Account ID to which this remarketing audience belongs.", - "type": "string" - }, - "audienceDefinition": { - "description": "The simple audience definition that will cause a user to be added to an audience.", - "properties": { - "includeConditions": { - "$ref": "IncludeConditions", - "description": "Defines the conditions to include users to the audience." - } - }, - "type": "object" - }, - "audienceType": { - "description": "The type of audience, either SIMPLE or STATE_BASED.", - "type": "string" - }, - "created": { - "description": "Time this remarketing audience was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "The description of this remarketing audience.", - "readOnly": true, - "type": "string" - }, - "id": { - "description": "Remarketing Audience ID.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for the web property to which this remarketing audience belongs.", - "readOnly": true, - "type": "string" - }, - "kind": { - "default": "analytics#remarketingAudience", - "description": "Collection type.", - "type": "string" - }, - "linkedAdAccounts": { - "description": "The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently.", - "items": { - "$ref": "LinkedForeignAccount" - }, - "type": "array" - }, - "linkedViews": { - "description": "The views (profiles) that this remarketing audience is linked to.", - "items": { - "type": "string" - }, - "type": "array" - }, - "name": { - "description": "The name of this remarketing audience.", - "type": "string" - }, - "stateBasedAudienceDefinition": { - "description": "A state based audience definition that will cause a user to be added or removed from an audience.", - "properties": { - "excludeConditions": { - "description": "Defines the conditions to exclude users from the audience.", - "properties": { - "exclusionDuration": { - "description": "Whether to make the exclusion TEMPORARY or PERMANENT.", - "type": "string" - }, - "segment": { - "description": "The segment condition that will cause a user to be removed from an audience.", - "type": "string" - } - }, - "type": "object" - }, - "includeConditions": { - "$ref": "IncludeConditions", - "description": "Defines the conditions to include users to the audience." - } - }, - "type": "object" - }, - "updated": { - "description": "Time this remarketing audience was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs.", - "type": "string" - } - }, - "type": "object" - }, - "RemarketingAudiences": { - "description": "A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience.", - "id": "RemarketingAudiences", - "properties": { - "items": { - "description": "A list of remarketing audiences.", - "items": { - "$ref": "RemarketingAudience" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#remarketingAudiences", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this remarketing audience collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this view (profile) collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "Segment": { - "description": "JSON template for an Analytics segment.", - "id": "Segment", - "properties": { - "created": { - "description": "Time the segment was created.", - "format": "date-time", - "type": "string" - }, - "definition": { - "description": "Segment definition.", - "type": "string" - }, - "id": { - "description": "Segment ID.", - "type": "string" - }, - "kind": { - "default": "analytics#segment", - "description": "Resource type for Analytics segment.", - "type": "string" - }, - "name": { - "description": "Segment name.", - "type": "string" - }, - "segmentId": { - "description": "Segment ID. Can be used with the 'segment' parameter in Core Reporting API.", - "type": "string" - }, - "selfLink": { - "description": "Link for this segment.", - "type": "string" - }, - "type": { - "description": "Type for a segment. Possible values are \"BUILT_IN\" or \"CUSTOM\".", - "type": "string" - }, - "updated": { - "description": "Time the segment was last modified.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "Segments": { - "description": "An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment.", - "id": "Segments", - "properties": { - "items": { - "description": "A list of segments.", - "items": { - "$ref": "Segment" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#segments", - "description": "Collection type for segments.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this segment collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this segment collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "UnsampledReport": { - "description": "JSON template for Analytics unsampled report resource.", - "id": "UnsampledReport", - "properties": { - "accountId": { - "description": "Account ID to which this unsampled report belongs.", - "type": "string" - }, - "cloudStorageDownloadDetails": { - "description": "Download details for a file stored in Google Cloud Storage.", - "properties": { - "bucketId": { - "description": "Id of the bucket the file object is stored in.", - "type": "string" - }, - "objectId": { - "description": "Id of the file object containing the report data.", - "type": "string" - } - }, - "readOnly": true, - "type": "object" - }, - "created": { - "description": "Time this unsampled report was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "dimensions": { - "description": "The dimensions for the unsampled report.", - "type": "string" - }, - "downloadType": { - "description": "The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field.", - "readOnly": true, - "type": "string" - }, - "driveDownloadDetails": { - "description": "Download details for a file stored in Google Drive.", - "properties": { - "documentId": { - "description": "Id of the document/file containing the report data.", - "type": "string" - } - }, - "readOnly": true, - "type": "object" - }, - "end-date": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.unsampledReports.insert" - ] - }, - "description": "The end date for the unsampled report.", - "type": "string" - }, - "filters": { - "description": "The filters for the unsampled report.", - "type": "string" - }, - "id": { - "description": "Unsampled report ID.", - "type": "string" - }, - "kind": { - "default": "analytics#unsampledReport", - "description": "Resource type for an Analytics unsampled report.", - "readOnly": true, - "type": "string" - }, - "metrics": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.unsampledReports.insert" - ] - }, - "description": "The metrics for the unsampled report.", - "type": "string" - }, - "profileId": { - "description": "View (Profile) ID to which this unsampled report belongs.", - "type": "string" - }, - "segment": { - "description": "The segment for the unsampled report.", - "type": "string" - }, - "selfLink": { - "description": "Link for this unsampled report.", - "readOnly": true, - "type": "string" - }, - "start-date": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.unsampledReports.insert" - ] - }, - "description": "The start date for the unsampled report.", - "type": "string" - }, - "status": { - "description": "Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED.", - "readOnly": true, - "type": "string" - }, - "title": { - "annotations": { - "required": [ - "analytics.management.filters.insert", - "analytics.management.unsampledReports.insert" - ] - }, - "description": "Title of the unsampled report.", - "type": "string" - }, - "updated": { - "description": "Time this unsampled report was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY.", - "type": "string" - } - }, - "type": "object" - }, - "UnsampledReports": { - "description": "An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report.", - "id": "UnsampledReports", - "properties": { - "items": { - "description": "A list of unsampled reports.", - "items": { - "$ref": "UnsampledReport" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#unsampledReports", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this unsampled report collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this unsampled report collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of resources in the result.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "Upload": { - "description": "Metadata returned for an upload operation.", - "id": "Upload", - "properties": { - "accountId": { - "description": "Account Id to which this upload belongs.", - "format": "int64", - "type": "string" - }, - "customDataSourceId": { - "description": "Custom data source Id to which this data import belongs.", - "type": "string" - }, - "errors": { - "description": "Data import errors collection.", - "items": { - "type": "string" - }, - "type": "array" - }, - "id": { - "description": "A unique ID for this upload.", - "type": "string" - }, - "kind": { - "default": "analytics#upload", - "description": "Resource type for Analytics upload.", - "type": "string" - }, - "status": { - "description": "Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED.", - "type": "string" - }, - "uploadTime": { - "description": "Time this file is uploaded.", - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "Uploads": { - "description": "Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload.", - "id": "Uploads", - "properties": { - "items": { - "description": "A list of uploads.", - "items": { - "$ref": "Upload" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#uploads", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this upload collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this upload collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of resources in the result.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "UserDeletionRequest": { - "description": "JSON template for a user deletion request resource.", - "id": "UserDeletionRequest", - "properties": { - "deletionRequestTime": { - "description": "This marks the point in time for which all user data before should be deleted", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "firebaseProjectId": { - "description": "Firebase Project Id", - "type": "string" - }, - "id": { - "description": "User ID.", - "properties": { - "type": { - "description": "Type of user", - "type": "string" - }, - "userId": { - "description": "The User's id", - "type": "string" - } - }, - "type": "object" - }, - "kind": { - "default": "analytics#userDeletionRequest", - "description": "Value is \"analytics#userDeletionRequest\".", - "type": "string" - }, - "propertyId": { - "description": "Property ID", - "type": "string" - }, - "webPropertyId": { - "description": "Web property ID of the form UA-XXXXX-YY.", - "type": "string" - } - }, - "type": "object" - }, - "UserRef": { - "description": "JSON template for a user reference.", - "id": "UserRef", - "properties": { - "email": { - "description": "Email ID of this user.", - "type": "string" - }, - "id": { - "description": "User ID.", - "type": "string" - }, - "kind": { - "default": "analytics#userRef", - "type": "string" - } - }, - "type": "object" - }, - "WebPropertyRef": { - "description": "JSON template for a web property reference.", - "id": "WebPropertyRef", - "properties": { - "accountId": { - "description": "Account ID to which this web property belongs.", - "type": "string" - }, - "href": { - "description": "Link for this web property.", - "type": "string" - }, - "id": { - "description": "Web property ID of the form UA-XXXXX-YY.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for this web property.", - "type": "string" - }, - "kind": { - "default": "analytics#webPropertyRef", - "description": "Analytics web property reference.", - "type": "string" - }, - "name": { - "description": "Name of this web property.", - "type": "string" - } - }, - "type": "object" - }, - "WebPropertySummary": { - "description": "JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property.", - "id": "WebPropertySummary", - "properties": { - "id": { - "description": "Web property ID of the form UA-XXXXX-YY.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for this web property.", - "type": "string" - }, - "kind": { - "default": "analytics#webPropertySummary", - "description": "Resource type for Analytics WebPropertySummary.", - "type": "string" - }, - "level": { - "description": "Level for this web property. Possible values are STANDARD or PREMIUM.", - "type": "string" - }, - "name": { - "description": "Web property name.", - "type": "string" - }, - "profiles": { - "description": "List of profiles under this web property.", - "items": { - "$ref": "ProfileSummary" - }, - "type": "array" - }, - "starred": { - "description": "Indicates whether this web property is starred or not.", - "type": "boolean" - }, - "websiteUrl": { - "description": "Website url for this web property.", - "type": "string" - } - }, - "type": "object" - }, - "Webproperties": { - "description": "A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property.", - "id": "Webproperties", - "properties": { - "items": { - "description": "A list of web properties.", - "items": { - "$ref": "Webproperty" - }, - "type": "array" - }, - "itemsPerPage": { - "description": "The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter.", - "format": "int32", - "type": "integer" - }, - "kind": { - "default": "analytics#webproperties", - "description": "Collection type.", - "type": "string" - }, - "nextLink": { - "description": "Link to next page for this web property collection.", - "type": "string" - }, - "previousLink": { - "description": "Link to previous page for this web property collection.", - "type": "string" - }, - "startIndex": { - "description": "The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter.", - "format": "int32", - "type": "integer" - }, - "totalResults": { - "description": "The total number of results for the query, regardless of the number of results in the response.", - "format": "int32", - "type": "integer" - }, - "username": { - "description": "Email ID of the authenticated user", - "type": "string" - } - }, - "type": "object" - }, - "Webproperty": { - "description": "JSON template for an Analytics web property.", - "id": "Webproperty", - "properties": { - "accountId": { - "description": "Account ID to which this web property belongs.", - "type": "string" - }, - "childLink": { - "description": "Child link for this web property. Points to the list of views (profiles) for this web property.", - "properties": { - "href": { - "description": "Link to the list of views (profiles) for this web property.", - "type": "string" - }, - "type": { - "default": "analytics#profiles", - "description": "Type of the parent link. Its value is \"analytics#profiles\".", - "type": "string" - } - }, - "type": "object" - }, - "created": { - "description": "Time this web property was created.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "dataRetentionResetOnNewActivity": { - "description": "Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period).\nSet to false to delete data associated with the user identifier automatically after the rentention period.\nThis property cannot be set on insert.", - "type": "boolean" - }, - "dataRetentionTtl": { - "description": "The length of time for which user and event data is retained.\nThis property cannot be set on insert.", - "type": "string" - }, - "defaultProfileId": { - "description": "Default view (profile) ID.", - "format": "int64", - "type": "string" - }, - "id": { - "description": "Web property ID of the form UA-XXXXX-YY.", - "type": "string" - }, - "industryVertical": { - "description": "The industry vertical/category selected for this web property.", - "type": "string" - }, - "internalWebPropertyId": { - "description": "Internal ID for this web property.", - "readOnly": true, - "type": "string" - }, - "kind": { - "default": "analytics#webproperty", - "description": "Resource type for Analytics WebProperty.", - "readOnly": true, - "type": "string" - }, - "level": { - "description": "Level for this web property. Possible values are STANDARD or PREMIUM.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Name of this web property.", - "type": "string" - }, - "parentLink": { - "description": "Parent link for this web property. Points to the account to which this web property belongs.", - "properties": { - "href": { - "description": "Link to the account for this web property.", - "type": "string" - }, - "type": { - "default": "analytics#account", - "description": "Type of the parent link. Its value is \"analytics#account\".", - "type": "string" - } - }, - "type": "object" - }, - "permissions": { - "description": "Permissions the user has for this web property.", - "properties": { - "effective": { - "description": "All the permissions that the user has for this web property. These include any implied permissions (e.g., EDIT implies VIEW) or inherited permissions from the parent account.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "profileCount": { - "description": "View (Profile) count for this web property.", - "format": "int32", - "readOnly": true, - "type": "integer" - }, - "selfLink": { - "description": "Link for this web property.", - "readOnly": true, - "type": "string" - }, - "starred": { - "description": "Indicates whether this web property is starred or not.", - "type": "boolean" - }, - "updated": { - "description": "Time this web property was last modified.", - "format": "date-time", - "readOnly": true, - "type": "string" - }, - "websiteUrl": { - "description": "Website url for this web property.", - "type": "string" - } - }, - "type": "object" - } - }, - "servicePath": "analytics/v3/", - "title": "Google Analytics API", - "version": "v3" -} \ No newline at end of file diff --git a/src/apis/analytics/v3.ts b/src/apis/analytics/v3.ts deleted file mode 100644 index 33504195233..00000000000 --- a/src/apis/analytics/v3.ts +++ /dev/null @@ -1,18783 +0,0 @@ -// Copyright 2020 Google LLC -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -/* eslint-disable @typescript-eslint/no-explicit-any */ -/* eslint-disable @typescript-eslint/no-unused-vars */ -/* eslint-disable @typescript-eslint/no-empty-interface */ -/* eslint-disable @typescript-eslint/no-namespace */ -/* eslint-disable no-irregular-whitespace */ - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, - BaseExternalAccountClient, - GaxiosResponseWithHTTP2, - GoogleConfigurable, - createAPIRequest, - MethodOptions, - StreamMethodOptions, - GlobalOptions, - GoogleAuth, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {Readable} from 'stream'; - -export namespace analytics_v3 { - export interface Options extends GlobalOptions { - version: 'v3'; - } - - interface StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: - | string - | OAuth2Client - | JWT - | Compute - | UserRefreshClient - | BaseExternalAccountClient - | GoogleAuth; - - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Google Analytics API - * - * Views and manages your Google Analytics data. - * - * @example - * ```js - * const {google} = require('googleapis'); - * const analytics = google.analytics('v3'); - * ``` - */ - export class Analytics { - context: APIRequestContext; - data: Resource$Data; - management: Resource$Management; - metadata: Resource$Metadata; - provisioning: Resource$Provisioning; - userDeletion: Resource$Userdeletion; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.data = new Resource$Data(this.context); - this.management = new Resource$Management(this.context); - this.metadata = new Resource$Metadata(this.context); - this.provisioning = new Resource$Provisioning(this.context); - this.userDeletion = new Resource$Userdeletion(this.context); - } - } - - /** - * JSON template for Analytics account entry. - */ - export interface Schema$Account { - /** - * Child link for an account entry. Points to the list of web properties for this account. - */ - childLink?: {href?: string; type?: string} | null; - /** - * Time the account was created. - */ - created?: string | null; - /** - * Account ID. - */ - id?: string | null; - /** - * Resource type for Analytics account. - */ - kind?: string | null; - /** - * Account name. - */ - name?: string | null; - /** - * Permissions the user has for this account. - */ - permissions?: {effective?: string[]} | null; - /** - * Link for this account. - */ - selfLink?: string | null; - /** - * Indicates whether this account is starred or not. - */ - starred?: boolean | null; - /** - * Time the account was last modified. - */ - updated?: string | null; - } - /** - * JSON template for a linked account. - */ - export interface Schema$AccountRef { - /** - * Link for this account. - */ - href?: string | null; - /** - * Account ID. - */ - id?: string | null; - /** - * Analytics account reference. - */ - kind?: string | null; - /** - * Account name. - */ - name?: string | null; - } - /** - * An account collection provides a list of Analytics accounts to which a user has access. The account collection is the entry point to all management information. Each resource in the collection corresponds to a single Analytics account. - */ - export interface Schema$Accounts { - /** - * A list of accounts. - */ - items?: Schema$Account[]; - /** - * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Next link for this account collection. - */ - nextLink?: string | null; - /** - * Previous link for this account collection. - */ - previousLink?: string | null; - /** - * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * An AccountSummary collection lists a summary of accounts, properties and views (profiles) to which the user has access. Each resource in the collection corresponds to a single AccountSummary. - */ - export interface Schema$AccountSummaries { - /** - * A list of AccountSummaries. - */ - items?: Schema$AccountSummary[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this AccountSummary collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this AccountSummary collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for an Analytics AccountSummary. An AccountSummary is a lightweight tree comprised of properties/profiles. - */ - export interface Schema$AccountSummary { - /** - * Account ID. - */ - id?: string | null; - /** - * Resource type for Analytics AccountSummary. - */ - kind?: string | null; - /** - * Account name. - */ - name?: string | null; - /** - * Indicates whether this account is starred or not. - */ - starred?: boolean | null; - /** - * List of web properties under this account. - */ - webProperties?: Schema$WebPropertySummary[]; - } - /** - * JSON template for an Analytics account ticket. The account ticket consists of the ticket ID and the basic information for the account, property and profile. - */ - export interface Schema$AccountTicket { - /** - * Account for this ticket. - */ - account?: Schema$Account; - /** - * Account ticket ID used to access the account ticket. - */ - id?: string | null; - /** - * Resource type for account ticket. - */ - kind?: string | null; - /** - * View (Profile) for the account. - */ - profile?: Schema$Profile; - /** - * Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in APIs console as a callback URL. - */ - redirectUri?: string | null; - /** - * Web property for the account. - */ - webproperty?: Schema$Webproperty; - } - /** - * JSON template for an Analytics account tree requests. The account tree request is used in the provisioning api to create an account, property, and view (profile). It contains the basic information required to make these fields. - */ - export interface Schema$AccountTreeRequest { - accountName?: string | null; - /** - * Resource type for account ticket. - */ - kind?: string | null; - profileName?: string | null; - timezone?: string | null; - webpropertyName?: string | null; - websiteUrl?: string | null; - } - /** - * JSON template for an Analytics account tree response. The account tree response is used in the provisioning api to return the result of creating an account, property, and view (profile). - */ - export interface Schema$AccountTreeResponse { - /** - * The account created. - */ - account?: Schema$Account; - /** - * Resource type for account ticket. - */ - kind?: string | null; - /** - * View (Profile) for the account. - */ - profile?: Schema$Profile; - /** - * Web property for the account. - */ - webproperty?: Schema$Webproperty; - } - /** - * JSON template for an Google Ads account. - */ - export interface Schema$AdWordsAccount { - /** - * True if auto-tagging is enabled on the Google Ads account. Read-only after the insert operation. - */ - autoTaggingEnabled?: boolean | null; - /** - * Customer ID. This field is required when creating a Google Ads link. - */ - customerId?: string | null; - /** - * Resource type for Google Ads account. - */ - kind?: string | null; - } - /** - * Request template for the delete upload data request. - */ - export interface Schema$AnalyticsDataimportDeleteUploadDataRequest { - /** - * A list of upload UIDs. - */ - customDataImportUids?: string[] | null; - } - /** - * JSON template for a metadata column. - */ - export interface Schema$Column { - /** - * Map of attribute name and value for this column. - */ - attributes?: {[key: string]: string} | null; - /** - * Column id. - */ - id?: string | null; - /** - * Resource type for Analytics column. - */ - kind?: string | null; - } - /** - * Lists columns (dimensions and metrics) for a particular report type. - */ - export interface Schema$Columns { - /** - * List of attributes names returned by columns. - */ - attributeNames?: string[] | null; - /** - * Etag of collection. This etag can be compared with the last response etag to check if response has changed. - */ - etag?: string | null; - /** - * List of columns for a report type. - */ - items?: Schema$Column[]; - /** - * Collection type. - */ - kind?: string | null; - /** - * Total number of columns returned in the response. - */ - totalResults?: number | null; - } - /** - * JSON template for an Analytics custom data source. - */ - export interface Schema$CustomDataSource { - /** - * Account ID to which this custom data source belongs. - */ - accountId?: string | null; - childLink?: {href?: string; type?: string} | null; - /** - * Time this custom data source was created. - */ - created?: string | null; - /** - * Description of custom data source. - */ - description?: string | null; - /** - * Custom data source ID. - */ - id?: string | null; - importBehavior?: string | null; - /** - * Resource type for Analytics custom data source. - */ - kind?: string | null; - /** - * Name of this custom data source. - */ - name?: string | null; - /** - * Parent link for this custom data source. Points to the web property to which this custom data source belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * IDs of views (profiles) linked to the custom data source. - */ - profilesLinked?: string[] | null; - /** - * Collection of schema headers of the custom data source. - */ - schema?: string[] | null; - /** - * Link for this Analytics custom data source. - */ - selfLink?: string | null; - /** - * Type of the custom data source. - */ - type?: string | null; - /** - * Time this custom data source was last modified. - */ - updated?: string | null; - /** - * Upload type of the custom data source. - */ - uploadType?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY to which this custom data source belongs. - */ - webPropertyId?: string | null; - } - /** - * Lists Analytics custom data sources to which the user has access. Each resource in the collection corresponds to a single Analytics custom data source. - */ - export interface Schema$CustomDataSources { - /** - * Collection of custom data sources. - */ - items?: Schema$CustomDataSource[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this custom data source collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this custom data source collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for Analytics Custom Dimension. - */ - export interface Schema$CustomDimension { - /** - * Account ID. - */ - accountId?: string | null; - /** - * Boolean indicating whether the custom dimension is active. - */ - active?: boolean | null; - /** - * Time the custom dimension was created. - */ - created?: string | null; - /** - * Custom dimension ID. - */ - id?: string | null; - /** - * Index of the custom dimension. - */ - index?: number | null; - /** - * Kind value for a custom dimension. Set to "analytics#customDimension". It is a read-only field. - */ - kind?: string | null; - /** - * Name of the custom dimension. - */ - name?: string | null; - /** - * Parent link for the custom dimension. Points to the property to which the custom dimension belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * Scope of the custom dimension: HIT, SESSION, USER or PRODUCT. - */ - scope?: string | null; - /** - * Link for the custom dimension - */ - selfLink?: string | null; - /** - * Time the custom dimension was last modified. - */ - updated?: string | null; - /** - * Property ID. - */ - webPropertyId?: string | null; - } - /** - * A custom dimension collection lists Analytics custom dimensions to which the user has access. Each resource in the collection corresponds to a single Analytics custom dimension. - */ - export interface Schema$CustomDimensions { - /** - * Collection of custom dimensions. - */ - items?: Schema$CustomDimension[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this custom dimension collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this custom dimension collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for Analytics Custom Metric. - */ - export interface Schema$CustomMetric { - /** - * Account ID. - */ - accountId?: string | null; - /** - * Boolean indicating whether the custom metric is active. - */ - active?: boolean | null; - /** - * Time the custom metric was created. - */ - created?: string | null; - /** - * Custom metric ID. - */ - id?: string | null; - /** - * Index of the custom metric. - */ - index?: number | null; - /** - * Kind value for a custom metric. Set to "analytics#customMetric". It is a read-only field. - */ - kind?: string | null; - /** - * Max value of custom metric. - */ - max_value?: string | null; - /** - * Min value of custom metric. - */ - min_value?: string | null; - /** - * Name of the custom metric. - */ - name?: string | null; - /** - * Parent link for the custom metric. Points to the property to which the custom metric belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * Scope of the custom metric: HIT or PRODUCT. - */ - scope?: string | null; - /** - * Link for the custom metric - */ - selfLink?: string | null; - /** - * Data type of custom metric. - */ - type?: string | null; - /** - * Time the custom metric was last modified. - */ - updated?: string | null; - /** - * Property ID. - */ - webPropertyId?: string | null; - } - /** - * A custom metric collection lists Analytics custom metrics to which the user has access. Each resource in the collection corresponds to a single Analytics custom metric. - */ - export interface Schema$CustomMetrics { - /** - * Collection of custom metrics. - */ - items?: Schema$CustomMetric[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this custom metric collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this custom metric collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for Analytics Entity Google Ads Link. - */ - export interface Schema$EntityAdWordsLink { - /** - * A list of Google Ads client accounts. These cannot be MCC accounts. This field is required when creating a Google Ads link. It cannot be empty. - */ - adWordsAccounts?: Schema$AdWordsAccount[]; - /** - * Web property being linked. - */ - entity?: {webPropertyRef?: Schema$WebPropertyRef} | null; - /** - * Entity Google Ads link ID - */ - id?: string | null; - /** - * Resource type for entity Google Ads link. - */ - kind?: string | null; - /** - * Name of the link. This field is required when creating a Google Ads link. - */ - name?: string | null; - /** - * IDs of linked Views (Profiles) represented as strings. - */ - profileIds?: string[] | null; - /** - * URL link for this Google Analytics - Google Ads link. - */ - selfLink?: string | null; - } - /** - * An entity Google Ads link collection provides a list of GA-Google Ads links Each resource in this collection corresponds to a single link. - */ - export interface Schema$EntityAdWordsLinks { - /** - * A list of entity Google Ads links. - */ - items?: Schema$EntityAdWordsLink[]; - /** - * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Next link for this Google Ads link collection. - */ - nextLink?: string | null; - /** - * Previous link for this Google Ads link collection. - */ - previousLink?: string | null; - /** - * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - } - /** - * JSON template for an Analytics Entity-User Link. Returns permissions that a user has for an entity. - */ - export interface Schema$EntityUserLink { - /** - * Entity for this link. It can be an account, a web property, or a view (profile). - */ - entity?: { - accountRef?: Schema$AccountRef; - profileRef?: Schema$ProfileRef; - webPropertyRef?: Schema$WebPropertyRef; - } | null; - /** - * Entity user link ID - */ - id?: string | null; - /** - * Resource type for entity user link. - */ - kind?: string | null; - /** - * Permissions the user has for this entity. - */ - permissions?: {effective?: string[]; local?: string[]} | null; - /** - * Self link for this resource. - */ - selfLink?: string | null; - /** - * User reference. - */ - userRef?: Schema$UserRef; - } - /** - * An entity user link collection provides a list of Analytics ACL links Each resource in this collection corresponds to a single link. - */ - export interface Schema$EntityUserLinks { - /** - * A list of entity user links. - */ - items?: Schema$EntityUserLink[]; - /** - * The maximum number of entries the response can contain, regardless of the actual number of entries returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Next link for this account collection. - */ - nextLink?: string | null; - /** - * Previous link for this account collection. - */ - previousLink?: string | null; - /** - * The starting index of the entries, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - } - /** - * JSON template for Analytics experiment resource. - */ - export interface Schema$Experiment { - /** - * Account ID to which this experiment belongs. This field is read-only. - */ - accountId?: string | null; - /** - * Time the experiment was created. This field is read-only. - */ - created?: string | null; - /** - * Notes about this experiment. - */ - description?: string | null; - /** - * If true, the end user will be able to edit the experiment via the Google Analytics user interface. - */ - editableInGaUi?: boolean | null; - /** - * The ending time of the experiment (the time the status changed from RUNNING to ENDED). This field is present only if the experiment has ended. This field is read-only. - */ - endTime?: string | null; - /** - * Boolean specifying whether to distribute traffic evenly across all variations. If the value is False, content experiments follows the default behavior of adjusting traffic dynamically based on variation performance. Optional -- defaults to False. This field may not be changed for an experiment whose status is ENDED. - */ - equalWeighting?: boolean | null; - /** - * Experiment ID. Required for patch and update. Disallowed for create. - */ - id?: string | null; - /** - * Internal ID for the web property to which this experiment belongs. This field is read-only. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for an Analytics experiment. This field is read-only. - */ - kind?: string | null; - /** - * An integer number in [3, 90]. Specifies the minimum length of the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. - */ - minimumExperimentLengthInDays?: number | null; - /** - * Experiment name. This field may not be changed for an experiment whose status is ENDED. This field is required when creating an experiment. - */ - name?: string | null; - /** - * The metric that the experiment is optimizing. Valid values: "ga:goal(n)Completions", "ga:adsenseAdsClicks", "ga:adsenseAdsViewed", "ga:adsenseRevenue", "ga:bounces", "ga:pageviews", "ga:sessionDuration", "ga:transactions", "ga:transactionRevenue". This field is required if status is "RUNNING" and servingFramework is one of "REDIRECT" or "API". - */ - objectiveMetric?: string | null; - /** - * Whether the objectiveMetric should be minimized or maximized. Possible values: "MAXIMUM", "MINIMUM". Optional--defaults to "MAXIMUM". Cannot be specified without objectiveMetric. Cannot be modified when status is "RUNNING" or "ENDED". - */ - optimizationType?: string | null; - /** - * Parent link for an experiment. Points to the view (profile) to which this experiment belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * View (Profile) ID to which this experiment belongs. This field is read-only. - */ - profileId?: string | null; - /** - * Why the experiment ended. Possible values: "STOPPED_BY_USER", "WINNER_FOUND", "EXPERIMENT_EXPIRED", "ENDED_WITH_NO_WINNER", "GOAL_OBJECTIVE_CHANGED". "ENDED_WITH_NO_WINNER" means that the experiment didn't expire but no winner was projected to be found. If the experiment status is changed via the API to ENDED this field is set to STOPPED_BY_USER. This field is read-only. - */ - reasonExperimentEnded?: string | null; - /** - * Boolean specifying whether variations URLS are rewritten to match those of the original. This field may not be changed for an experiments whose status is ENDED. - */ - rewriteVariationUrlsAsOriginal?: boolean | null; - /** - * Link for this experiment. This field is read-only. - */ - selfLink?: string | null; - /** - * The framework used to serve the experiment variations and evaluate the results. One of: - * - REDIRECT: Google Analytics redirects traffic to different variation pages, reports the chosen variation and evaluates the results. - * - API: Google Analytics chooses and reports the variation to serve and evaluates the results; the caller is responsible for serving the selected variation. - * - EXTERNAL: The variations will be served externally and the chosen variation reported to Google Analytics. The caller is responsible for serving the selected variation and evaluating the results. - */ - servingFramework?: string | null; - /** - * The snippet of code to include on the control page(s). This field is read-only. - */ - snippet?: string | null; - /** - * The starting time of the experiment (the time the status changed from READY_TO_RUN to RUNNING). This field is present only if the experiment has started. This field is read-only. - */ - startTime?: string | null; - /** - * Experiment status. Possible values: "DRAFT", "READY_TO_RUN", "RUNNING", "ENDED". Experiments can be created in the "DRAFT", "READY_TO_RUN" or "RUNNING" state. This field is required when creating an experiment. - */ - status?: string | null; - /** - * A floating-point number in (0, 1]. Specifies the fraction of the traffic that participates in the experiment. Can be changed for a running experiment. This field may not be changed for an experiments whose status is ENDED. - */ - trafficCoverage?: number | null; - /** - * Time the experiment was last modified. This field is read-only. - */ - updated?: string | null; - /** - * Array of variations. The first variation in the array is the original. The number of variations may not change once an experiment is in the RUNNING state. At least two variations are required before status can be set to RUNNING. - */ - variations?: Array<{ - name?: string; - status?: string; - url?: string; - weight?: number; - won?: boolean; - }> | null; - /** - * Web property ID to which this experiment belongs. The web property ID is of the form UA-XXXXX-YY. This field is read-only. - */ - webPropertyId?: string | null; - /** - * A floating-point number in (0, 1). Specifies the necessary confidence level to choose a winner. This field may not be changed for an experiments whose status is ENDED. - */ - winnerConfidenceLevel?: number | null; - /** - * Boolean specifying whether a winner has been found for this experiment. This field is read-only. - */ - winnerFound?: boolean | null; - } - /** - * An experiment collection lists Analytics experiments to which the user has access. Each view (profile) can have a set of experiments. Each resource in the Experiment collection corresponds to a single Analytics experiment. - */ - export interface Schema$Experiments { - /** - * A list of experiments. - */ - items?: Schema$Experiment[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this experiment collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this experiment collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of resources in the result. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for an Analytics account filter. - */ - export interface Schema$Filter { - /** - * Account ID to which this filter belongs. - */ - accountId?: string | null; - /** - * Details for the filter of the type ADVANCED. - */ - advancedDetails?: { - caseSensitive?: boolean; - extractA?: string; - extractB?: string; - fieldA?: string; - fieldAIndex?: number; - fieldARequired?: boolean; - fieldB?: string; - fieldBIndex?: number; - fieldBRequired?: boolean; - outputConstructor?: string; - outputToField?: string; - outputToFieldIndex?: number; - overrideOutputField?: boolean; - } | null; - /** - * Time this filter was created. - */ - created?: string | null; - /** - * Details for the filter of the type EXCLUDE. - */ - excludeDetails?: Schema$FilterExpression; - /** - * Filter ID. - */ - id?: string | null; - /** - * Details for the filter of the type INCLUDE. - */ - includeDetails?: Schema$FilterExpression; - /** - * Resource type for Analytics filter. - */ - kind?: string | null; - /** - * Details for the filter of the type LOWER. - */ - lowercaseDetails?: {field?: string; fieldIndex?: number} | null; - /** - * Name of this filter. - */ - name?: string | null; - /** - * Parent link for this filter. Points to the account to which this filter belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * Details for the filter of the type SEARCH_AND_REPLACE. - */ - searchAndReplaceDetails?: { - caseSensitive?: boolean; - field?: string; - fieldIndex?: number; - replaceString?: string; - searchString?: string; - } | null; - /** - * Link for this filter. - */ - selfLink?: string | null; - /** - * Type of this filter. Possible values are INCLUDE, EXCLUDE, LOWERCASE, UPPERCASE, SEARCH_AND_REPLACE and ADVANCED. - */ - type?: string | null; - /** - * Time this filter was last modified. - */ - updated?: string | null; - /** - * Details for the filter of the type UPPER. - */ - uppercaseDetails?: {field?: string; fieldIndex?: number} | null; - } - /** - * JSON template for an Analytics filter expression. - */ - export interface Schema$FilterExpression { - /** - * Determines if the filter is case sensitive. - */ - caseSensitive?: boolean | null; - /** - * Filter expression value - */ - expressionValue?: string | null; - /** - * Field to filter. Possible values: - * - Content and Traffic - * - PAGE_REQUEST_URI, - * - PAGE_HOSTNAME, - * - PAGE_TITLE, - * - REFERRAL, - * - COST_DATA_URI (Campaign target URL), - * - HIT_TYPE, - * - INTERNAL_SEARCH_TERM, - * - INTERNAL_SEARCH_TYPE, - * - SOURCE_PROPERTY_TRACKING_ID, - * - Campaign or AdGroup - * - CAMPAIGN_SOURCE, - * - CAMPAIGN_MEDIUM, - * - CAMPAIGN_NAME, - * - CAMPAIGN_AD_GROUP, - * - CAMPAIGN_TERM, - * - CAMPAIGN_CONTENT, - * - CAMPAIGN_CODE, - * - CAMPAIGN_REFERRAL_PATH, - * - E-Commerce - * - TRANSACTION_COUNTRY, - * - TRANSACTION_REGION, - * - TRANSACTION_CITY, - * - TRANSACTION_AFFILIATION (Store or order location), - * - ITEM_NAME, - * - ITEM_CODE, - * - ITEM_VARIATION, - * - TRANSACTION_ID, - * - TRANSACTION_CURRENCY_CODE, - * - PRODUCT_ACTION_TYPE, - * - Audience/Users - * - BROWSER, - * - BROWSER_VERSION, - * - BROWSER_SIZE, - * - PLATFORM, - * - PLATFORM_VERSION, - * - LANGUAGE, - * - SCREEN_RESOLUTION, - * - SCREEN_COLORS, - * - JAVA_ENABLED (Boolean Field), - * - FLASH_VERSION, - * - GEO_SPEED (Connection speed), - * - VISITOR_TYPE, - * - GEO_ORGANIZATION (ISP organization), - * - GEO_DOMAIN, - * - GEO_IP_ADDRESS, - * - GEO_IP_VERSION, - * - Location - * - GEO_COUNTRY, - * - GEO_REGION, - * - GEO_CITY, - * - Event - * - EVENT_CATEGORY, - * - EVENT_ACTION, - * - EVENT_LABEL, - * - Other - * - CUSTOM_FIELD_1, - * - CUSTOM_FIELD_2, - * - USER_DEFINED_VALUE, - * - Application - * - APP_ID, - * - APP_INSTALLER_ID, - * - APP_NAME, - * - APP_VERSION, - * - SCREEN, - * - IS_APP (Boolean Field), - * - IS_FATAL_EXCEPTION (Boolean Field), - * - EXCEPTION_DESCRIPTION, - * - Mobile device - * - IS_MOBILE (Boolean Field, Deprecated. Use DEVICE_CATEGORY=mobile), - * - IS_TABLET (Boolean Field, Deprecated. Use DEVICE_CATEGORY=tablet), - * - DEVICE_CATEGORY, - * - MOBILE_HAS_QWERTY_KEYBOARD (Boolean Field), - * - MOBILE_HAS_NFC_SUPPORT (Boolean Field), - * - MOBILE_HAS_CELLULAR_RADIO (Boolean Field), - * - MOBILE_HAS_WIFI_SUPPORT (Boolean Field), - * - MOBILE_BRAND_NAME, - * - MOBILE_MODEL_NAME, - * - MOBILE_MARKETING_NAME, - * - MOBILE_POINTING_METHOD, - * - Social - * - SOCIAL_NETWORK, - * - SOCIAL_ACTION, - * - SOCIAL_ACTION_TARGET, - * - Custom dimension - * - CUSTOM_DIMENSION (See accompanying field index), - */ - field?: string | null; - /** - * The Index of the custom dimension. Set only if the field is a is CUSTOM_DIMENSION. - */ - fieldIndex?: number | null; - /** - * Kind value for filter expression - */ - kind?: string | null; - /** - * Match type for this filter. Possible values are BEGINS_WITH, EQUAL, ENDS_WITH, CONTAINS, or MATCHES. GEO_DOMAIN, GEO_IP_ADDRESS, PAGE_REQUEST_URI, or PAGE_HOSTNAME filters can use any match type; all other filters must use MATCHES. - */ - matchType?: string | null; - } - /** - * JSON template for a profile filter link. - */ - export interface Schema$FilterRef { - /** - * Account ID to which this filter belongs. - */ - accountId?: string | null; - /** - * Link for this filter. - */ - href?: string | null; - /** - * Filter ID. - */ - id?: string | null; - /** - * Kind value for filter reference. - */ - kind?: string | null; - /** - * Name of this filter. - */ - name?: string | null; - } - /** - * A filter collection lists filters created by users in an Analytics account. Each resource in the collection corresponds to a filter. - */ - export interface Schema$Filters { - /** - * A list of filters. - */ - items?: Schema$Filter[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this filter collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this filter collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * Analytics data for a given view (profile). - */ - export interface Schema$GaData { - /** - * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. - */ - columnHeaders?: Array<{ - columnType?: string; - dataType?: string; - name?: string; - }> | null; - /** - * Determines if Analytics data contains samples. - */ - containsSampledData?: boolean | null; - /** - * The last refreshed time in seconds for Analytics data. - */ - dataLastRefreshed?: string | null; - dataTable?: { - cols?: Array<{id?: string; label?: string; type?: string}>; - rows?: Array<{c?: Array<{v?: string}>}>; - } | null; - /** - * Unique ID for this data response. - */ - id?: string | null; - /** - * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Resource type. - */ - kind?: string | null; - /** - * Link to next page for this Analytics data query. - */ - nextLink?: string | null; - /** - * Link to previous page for this Analytics data query. - */ - previousLink?: string | null; - /** - * Information for the view (profile), for which the Analytics data was requested. - */ - profileInfo?: { - accountId?: string; - internalWebPropertyId?: string; - profileId?: string; - profileName?: string; - tableId?: string; - webPropertyId?: string; - } | null; - /** - * Analytics data request query parameters. - */ - query?: { - dimensions?: string; - 'end-date'?: string; - filters?: string; - ids?: string; - 'max-results'?: number; - metrics?: string[]; - samplingLevel?: string; - segment?: string; - sort?: string[]; - 'start-date'?: string; - 'start-index'?: number; - } | null; - /** - * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. - */ - rows?: string[][] | null; - /** - * The number of samples used to calculate the result. - */ - sampleSize?: string | null; - /** - * Total size of the sample space from which the samples were selected. - */ - sampleSpace?: string | null; - /** - * Link to this page. - */ - selfLink?: string | null; - /** - * The total number of rows for the query, regardless of the number of rows in the response. - */ - totalResults?: number | null; - /** - * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. - */ - totalsForAllResults?: {[key: string]: string} | null; - } - /** - * JSON template for Analytics goal resource. - */ - export interface Schema$Goal { - /** - * Account ID to which this goal belongs. - */ - accountId?: string | null; - /** - * Determines whether this goal is active. - */ - active?: boolean | null; - /** - * Time this goal was created. - */ - created?: string | null; - /** - * Details for the goal of the type EVENT. - */ - eventDetails?: { - eventConditions?: Array<{ - comparisonType?: string; - comparisonValue?: string; - expression?: string; - matchType?: string; - type?: string; - }>; - useEventValue?: boolean; - } | null; - /** - * Goal ID. - */ - id?: string | null; - /** - * Internal ID for the web property to which this goal belongs. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for an Analytics goal. - */ - kind?: string | null; - /** - * Goal name. - */ - name?: string | null; - /** - * Parent link for a goal. Points to the view (profile) to which this goal belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * View (Profile) ID to which this goal belongs. - */ - profileId?: string | null; - /** - * Link for this goal. - */ - selfLink?: string | null; - /** - * Goal type. Possible values are URL_DESTINATION, VISIT_TIME_ON_SITE, VISIT_NUM_PAGES, AND EVENT. - */ - type?: string | null; - /** - * Time this goal was last modified. - */ - updated?: string | null; - /** - * Details for the goal of the type URL_DESTINATION. - */ - urlDestinationDetails?: { - caseSensitive?: boolean; - firstStepRequired?: boolean; - matchType?: string; - steps?: Array<{name?: string; number?: number; url?: string}>; - url?: string; - } | null; - /** - * Goal value. - */ - value?: number | null; - /** - * Details for the goal of the type VISIT_NUM_PAGES. - */ - visitNumPagesDetails?: { - comparisonType?: string; - comparisonValue?: string; - } | null; - /** - * Details for the goal of the type VISIT_TIME_ON_SITE. - */ - visitTimeOnSiteDetails?: { - comparisonType?: string; - comparisonValue?: string; - } | null; - /** - * Web property ID to which this goal belongs. The web property ID is of the form UA-XXXXX-YY. - */ - webPropertyId?: string | null; - } - /** - * A goal collection lists Analytics goals to which the user has access. Each view (profile) can have a set of goals. Each resource in the Goal collection corresponds to a single Analytics goal. - */ - export interface Schema$Goals { - /** - * A list of goals. - */ - items?: Schema$Goal[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this goal collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this goal collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of resources in the result. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for a hash Client Id request resource. - */ - export interface Schema$HashClientIdRequest { - clientId?: string | null; - kind?: string | null; - webPropertyId?: string | null; - } - /** - * JSON template for a hash Client Id response resource. - */ - export interface Schema$HashClientIdResponse { - clientId?: string | null; - hashedClientId?: string | null; - kind?: string | null; - webPropertyId?: string | null; - } - /** - * JSON template for an Analytics Remarketing Include Conditions. - */ - export interface Schema$IncludeConditions { - /** - * The look-back window lets you specify a time frame for evaluating the behavior that qualifies users for your audience. For example, if your filters include users from Central Asia, and Transactions Greater than 2, and you set the look-back window to 14 days, then any user from Central Asia whose cumulative transactions exceed 2 during the last 14 days is added to the audience. - */ - daysToLookBack?: number | null; - /** - * Boolean indicating whether this segment is a smart list. https://support.google.com/analytics/answer/4628577 - */ - isSmartList?: boolean | null; - /** - * Resource type for include conditions. - */ - kind?: string | null; - /** - * Number of days (in the range 1 to 540) a user remains in the audience. - */ - membershipDurationDays?: number | null; - /** - * The segment condition that will cause a user to be added to an audience. - */ - segment?: string | null; - } - /** - * JSON template for an Analytics Remarketing Audience Foreign Link. - */ - export interface Schema$LinkedForeignAccount { - /** - * Account ID to which this linked foreign account belongs. - */ - accountId?: string | null; - /** - * Boolean indicating whether this is eligible for search. - */ - eligibleForSearch?: boolean | null; - /** - * Entity ad account link ID. - */ - id?: string | null; - /** - * Internal ID for the web property to which this linked foreign account belongs. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for linked foreign account. - */ - kind?: string | null; - /** - * The foreign account ID. For example the an Google Ads `linkedAccountId` has the following format XXX-XXX-XXXX. - */ - linkedAccountId?: string | null; - /** - * Remarketing audience ID to which this linked foreign account belongs. - */ - remarketingAudienceId?: string | null; - /** - * The status of this foreign account link. - */ - status?: string | null; - /** - * The type of the foreign account. For example, `ADWORDS_LINKS`, `DBM_LINKS`, `MCC_LINKS` or `OPTIMIZE`. - */ - type?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY to which this linked foreign account belongs. - */ - webPropertyId?: string | null; - } - /** - * Multi-Channel Funnels data for a given view (profile). - */ - export interface Schema$McfData { - /** - * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. - */ - columnHeaders?: Array<{ - columnType?: string; - dataType?: string; - name?: string; - }> | null; - /** - * Determines if the Analytics data contains sampled data. - */ - containsSampledData?: boolean | null; - /** - * Unique ID for this data response. - */ - id?: string | null; - /** - * The maximum number of rows the response can contain, regardless of the actual number of rows returned. Its value ranges from 1 to 10,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Resource type. - */ - kind?: string | null; - /** - * Link to next page for this Analytics data query. - */ - nextLink?: string | null; - /** - * Link to previous page for this Analytics data query. - */ - previousLink?: string | null; - /** - * Information for the view (profile), for which the Analytics data was requested. - */ - profileInfo?: { - accountId?: string; - internalWebPropertyId?: string; - profileId?: string; - profileName?: string; - tableId?: string; - webPropertyId?: string; - } | null; - /** - * Analytics data request query parameters. - */ - query?: { - dimensions?: string; - 'end-date'?: string; - filters?: string; - ids?: string; - 'max-results'?: number; - metrics?: string[]; - samplingLevel?: string; - segment?: string; - sort?: string[]; - 'start-date'?: string; - 'start-index'?: number; - } | null; - /** - * Analytics data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. - */ - rows?: Array< - Array<{ - conversionPathValue?: Array<{ - interactionType?: string; - nodeValue?: string; - }>; - primitiveValue?: string; - }> - > | null; - /** - * The number of samples used to calculate the result. - */ - sampleSize?: string | null; - /** - * Total size of the sample space from which the samples were selected. - */ - sampleSpace?: string | null; - /** - * Link to this page. - */ - selfLink?: string | null; - /** - * The total number of rows for the query, regardless of the number of rows in the response. - */ - totalResults?: number | null; - /** - * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. - */ - totalsForAllResults?: {[key: string]: string} | null; - } - /** - * JSON template for an Analytics view (profile). - */ - export interface Schema$Profile { - /** - * Account ID to which this view (profile) belongs. - */ - accountId?: string | null; - /** - * Indicates whether bot filtering is enabled for this view (profile). - */ - botFilteringEnabled?: boolean | null; - /** - * Child link for this view (profile). Points to the list of goals for this view (profile). - */ - childLink?: {href?: string; type?: string} | null; - /** - * Time this view (profile) was created. - */ - created?: string | null; - /** - * The currency type associated with this view (profile), defaults to USD. The supported values are: - * USD, JPY, EUR, GBP, AUD, KRW, BRL, CNY, DKK, RUB, SEK, NOK, PLN, TRY, TWD, HKD, THB, IDR, ARS, MXN, VND, PHP, INR, CHF, CAD, CZK, NZD, HUF, BGN, LTL, ZAR, UAH, AED, BOB, CLP, COP, EGP, HRK, ILS, MAD, MYR, PEN, PKR, RON, RSD, SAR, SGD, VEF, LVL - */ - currency?: string | null; - /** - * Default page for this view (profile). - */ - defaultPage?: string | null; - /** - * Indicates whether ecommerce tracking is enabled for this view (profile). - */ - eCommerceTracking?: boolean | null; - /** - * Indicates whether enhanced ecommerce tracking is enabled for this view (profile). This property can only be enabled if ecommerce tracking is enabled. - */ - enhancedECommerceTracking?: boolean | null; - /** - * The query parameters that are excluded from this view (profile). - */ - excludeQueryParameters?: string | null; - /** - * View (Profile) ID. - */ - id?: string | null; - /** - * Internal ID for the web property to which this view (profile) belongs. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for Analytics view (profile). - */ - kind?: string | null; - /** - * Name of this view (profile). - */ - name?: string | null; - /** - * Parent link for this view (profile). Points to the web property to which this view (profile) belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * Permissions the user has for this view (profile). - */ - permissions?: {effective?: string[]} | null; - /** - * Link for this view (profile). - */ - selfLink?: string | null; - /** - * Site search category parameters for this view (profile). - */ - siteSearchCategoryParameters?: string | null; - /** - * The site search query parameters for this view (profile). - */ - siteSearchQueryParameters?: string | null; - /** - * Indicates whether this view (profile) is starred or not. - */ - starred?: boolean | null; - /** - * Whether or not Analytics will strip search category parameters from the URLs in your reports. - */ - stripSiteSearchCategoryParameters?: boolean | null; - /** - * Whether or not Analytics will strip search query parameters from the URLs in your reports. - */ - stripSiteSearchQueryParameters?: boolean | null; - /** - * Time zone for which this view (profile) has been configured. Time zones are identified by strings from the TZ database. - */ - timezone?: string | null; - /** - * View (Profile) type. Supported types: WEB or APP. - */ - type?: string | null; - /** - * Time this view (profile) was last modified. - */ - updated?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. - */ - webPropertyId?: string | null; - /** - * Website URL for this view (profile). - */ - websiteUrl?: string | null; - } - /** - * JSON template for an Analytics profile filter link. - */ - export interface Schema$ProfileFilterLink { - /** - * Filter for this link. - */ - filterRef?: Schema$FilterRef; - /** - * Profile filter link ID. - */ - id?: string | null; - /** - * Resource type for Analytics filter. - */ - kind?: string | null; - /** - * View (Profile) for this link. - */ - profileRef?: Schema$ProfileRef; - /** - * The rank of this profile filter link relative to the other filters linked to the same profile. - * For readonly (i.e., list and get) operations, the rank always starts at 1. - * For write (i.e., create, update, or delete) operations, you may specify a value between 0 and 255 inclusively, [0, 255]. In order to insert a link at the end of the list, either don't specify a rank or set a rank to a number greater than the largest rank in the list. In order to insert a link to the beginning of the list specify a rank that is less than or equal to 1. The new link will move all existing filters with the same or lower rank down the list. After the link is inserted/updated/deleted all profile filter links will be renumbered starting at 1. - */ - rank?: number | null; - /** - * Link for this profile filter link. - */ - selfLink?: string | null; - } - /** - * A profile filter link collection lists profile filter links between profiles and filters. Each resource in the collection corresponds to a profile filter link. - */ - export interface Schema$ProfileFilterLinks { - /** - * A list of profile filter links. - */ - items?: Schema$ProfileFilterLink[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1,000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this profile filter link collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this profile filter link collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for a linked view (profile). - */ - export interface Schema$ProfileRef { - /** - * Account ID to which this view (profile) belongs. - */ - accountId?: string | null; - /** - * Link for this view (profile). - */ - href?: string | null; - /** - * View (Profile) ID. - */ - id?: string | null; - /** - * Internal ID for the web property to which this view (profile) belongs. - */ - internalWebPropertyId?: string | null; - /** - * Analytics view (profile) reference. - */ - kind?: string | null; - /** - * Name of this view (profile). - */ - name?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY to which this view (profile) belongs. - */ - webPropertyId?: string | null; - } - /** - * A view (profile) collection lists Analytics views (profiles) to which the user has access. Each resource in the collection corresponds to a single Analytics view (profile). - */ - export interface Schema$Profiles { - /** - * A list of views (profiles). - */ - items?: Schema$Profile[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this view (profile) collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this view (profile) collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for an Analytics ProfileSummary. ProfileSummary returns basic information (i.e., summary) for a profile. - */ - export interface Schema$ProfileSummary { - /** - * View (profile) ID. - */ - id?: string | null; - /** - * Resource type for Analytics ProfileSummary. - */ - kind?: string | null; - /** - * View (profile) name. - */ - name?: string | null; - /** - * Indicates whether this view (profile) is starred or not. - */ - starred?: boolean | null; - /** - * View (Profile) type. Supported types: WEB or APP. - */ - type?: string | null; - } - /** - * Real time data for a given view (profile). - */ - export interface Schema$RealtimeData { - /** - * Column headers that list dimension names followed by the metric names. The order of dimensions and metrics is same as specified in the request. - */ - columnHeaders?: Array<{ - columnType?: string; - dataType?: string; - name?: string; - }> | null; - /** - * Unique ID for this data response. - */ - id?: string | null; - /** - * Resource type. - */ - kind?: string | null; - /** - * Information for the view (profile), for which the real time data was requested. - */ - profileInfo?: { - accountId?: string; - internalWebPropertyId?: string; - profileId?: string; - profileName?: string; - tableId?: string; - webPropertyId?: string; - } | null; - /** - * Real time data request query parameters. - */ - query?: { - dimensions?: string; - filters?: string; - ids?: string; - 'max-results'?: number; - metrics?: string[]; - sort?: string[]; - } | null; - /** - * Real time data rows, where each row contains a list of dimension values followed by the metric values. The order of dimensions and metrics is same as specified in the request. - */ - rows?: string[][] | null; - /** - * Link to this page. - */ - selfLink?: string | null; - /** - * The total number of rows for the query, regardless of the number of rows in the response. - */ - totalResults?: number | null; - /** - * Total values for the requested metrics over all the results, not just the results returned in this response. The order of the metric totals is same as the metric order specified in the request. - */ - totalsForAllResults?: {[key: string]: string} | null; - } - /** - * JSON template for an Analytics remarketing audience. - */ - export interface Schema$RemarketingAudience { - /** - * Account ID to which this remarketing audience belongs. - */ - accountId?: string | null; - /** - * The simple audience definition that will cause a user to be added to an audience. - */ - audienceDefinition?: {includeConditions?: Schema$IncludeConditions} | null; - /** - * The type of audience, either SIMPLE or STATE_BASED. - */ - audienceType?: string | null; - /** - * Time this remarketing audience was created. - */ - created?: string | null; - /** - * The description of this remarketing audience. - */ - description?: string | null; - /** - * Remarketing Audience ID. - */ - id?: string | null; - /** - * Internal ID for the web property to which this remarketing audience belongs. - */ - internalWebPropertyId?: string | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * The linked ad accounts associated with this remarketing audience. A remarketing audience can have only one linkedAdAccount currently. - */ - linkedAdAccounts?: Schema$LinkedForeignAccount[]; - /** - * The views (profiles) that this remarketing audience is linked to. - */ - linkedViews?: string[] | null; - /** - * The name of this remarketing audience. - */ - name?: string | null; - /** - * A state based audience definition that will cause a user to be added or removed from an audience. - */ - stateBasedAudienceDefinition?: { - excludeConditions?: {exclusionDuration?: string; segment?: string}; - includeConditions?: Schema$IncludeConditions; - } | null; - /** - * Time this remarketing audience was last modified. - */ - updated?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY to which this remarketing audience belongs. - */ - webPropertyId?: string | null; - } - /** - * A remarketing audience collection lists Analytics remarketing audiences to which the user has access. Each resource in the collection corresponds to a single Analytics remarketing audience. - */ - export interface Schema$RemarketingAudiences { - /** - * A list of remarketing audiences. - */ - items?: Schema$RemarketingAudience[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this remarketing audience collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this view (profile) collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for an Analytics segment. - */ - export interface Schema$Segment { - /** - * Time the segment was created. - */ - created?: string | null; - /** - * Segment definition. - */ - definition?: string | null; - /** - * Segment ID. - */ - id?: string | null; - /** - * Resource type for Analytics segment. - */ - kind?: string | null; - /** - * Segment name. - */ - name?: string | null; - /** - * Segment ID. Can be used with the 'segment' parameter in Core Reporting API. - */ - segmentId?: string | null; - /** - * Link for this segment. - */ - selfLink?: string | null; - /** - * Type for a segment. Possible values are "BUILT_IN" or "CUSTOM". - */ - type?: string | null; - /** - * Time the segment was last modified. - */ - updated?: string | null; - } - /** - * An segment collection lists Analytics segments that the user has access to. Each resource in the collection corresponds to a single Analytics segment. - */ - export interface Schema$Segments { - /** - * A list of segments. - */ - items?: Schema$Segment[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type for segments. - */ - kind?: string | null; - /** - * Link to next page for this segment collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this segment collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for Analytics unsampled report resource. - */ - export interface Schema$UnsampledReport { - /** - * Account ID to which this unsampled report belongs. - */ - accountId?: string | null; - /** - * Download details for a file stored in Google Cloud Storage. - */ - cloudStorageDownloadDetails?: {bucketId?: string; objectId?: string} | null; - /** - * Time this unsampled report was created. - */ - created?: string | null; - /** - * The dimensions for the unsampled report. - */ - dimensions?: string | null; - /** - * The type of download you need to use for the report data file. Possible values include `GOOGLE_DRIVE` and `GOOGLE_CLOUD_STORAGE`. If the value is `GOOGLE_DRIVE`, see the `driveDownloadDetails` field. If the value is `GOOGLE_CLOUD_STORAGE`, see the `cloudStorageDownloadDetails` field. - */ - downloadType?: string | null; - /** - * Download details for a file stored in Google Drive. - */ - driveDownloadDetails?: {documentId?: string} | null; - /** - * The end date for the unsampled report. - */ - 'end-date'?: string | null; - /** - * The filters for the unsampled report. - */ - filters?: string | null; - /** - * Unsampled report ID. - */ - id?: string | null; - /** - * Resource type for an Analytics unsampled report. - */ - kind?: string | null; - /** - * The metrics for the unsampled report. - */ - metrics?: string | null; - /** - * View (Profile) ID to which this unsampled report belongs. - */ - profileId?: string | null; - /** - * The segment for the unsampled report. - */ - segment?: string | null; - /** - * Link for this unsampled report. - */ - selfLink?: string | null; - /** - * The start date for the unsampled report. - */ - 'start-date'?: string | null; - /** - * Status of this unsampled report. Possible values are PENDING, COMPLETED, or FAILED. - */ - status?: string | null; - /** - * Title of the unsampled report. - */ - title?: string | null; - /** - * Time this unsampled report was last modified. - */ - updated?: string | null; - /** - * Web property ID to which this unsampled report belongs. The web property ID is of the form UA-XXXXX-YY. - */ - webPropertyId?: string | null; - } - /** - * An unsampled report collection lists Analytics unsampled reports to which the user has access. Each view (profile) can have a set of unsampled reports. Each resource in the unsampled report collection corresponds to a single Analytics unsampled report. - */ - export interface Schema$UnsampledReports { - /** - * A list of unsampled reports. - */ - items?: Schema$UnsampledReport[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this unsampled report collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this unsampled report collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of resources in the result. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * Metadata returned for an upload operation. - */ - export interface Schema$Upload { - /** - * Account Id to which this upload belongs. - */ - accountId?: string | null; - /** - * Custom data source Id to which this data import belongs. - */ - customDataSourceId?: string | null; - /** - * Data import errors collection. - */ - errors?: string[] | null; - /** - * A unique ID for this upload. - */ - id?: string | null; - /** - * Resource type for Analytics upload. - */ - kind?: string | null; - /** - * Upload status. Possible values: PENDING, COMPLETED, FAILED, DELETING, DELETED. - */ - status?: string | null; - /** - * Time this file is uploaded. - */ - uploadTime?: string | null; - } - /** - * Upload collection lists Analytics uploads to which the user has access. Each custom data source can have a set of uploads. Each resource in the upload collection corresponds to a single Analytics data upload. - */ - export interface Schema$Uploads { - /** - * A list of uploads. - */ - items?: Schema$Upload[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this upload collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this upload collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of resources in the result. - */ - totalResults?: number | null; - } - /** - * JSON template for a user deletion request resource. - */ - export interface Schema$UserDeletionRequest { - /** - * This marks the point in time for which all user data before should be deleted - */ - deletionRequestTime?: string | null; - /** - * Firebase Project Id - */ - firebaseProjectId?: string | null; - /** - * User ID. - */ - id?: {type?: string; userId?: string} | null; - /** - * Value is "analytics#userDeletionRequest". - */ - kind?: string | null; - /** - * Property ID - */ - propertyId?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY. - */ - webPropertyId?: string | null; - } - /** - * JSON template for a user reference. - */ - export interface Schema$UserRef { - /** - * Email ID of this user. - */ - email?: string | null; - /** - * User ID. - */ - id?: string | null; - kind?: string | null; - } - /** - * A web property collection lists Analytics web properties to which the user has access. Each resource in the collection corresponds to a single Analytics web property. - */ - export interface Schema$Webproperties { - /** - * A list of web properties. - */ - items?: Schema$Webproperty[]; - /** - * The maximum number of resources the response can contain, regardless of the actual number of resources returned. Its value ranges from 1 to 1000 with a value of 1000 by default, or otherwise specified by the max-results query parameter. - */ - itemsPerPage?: number | null; - /** - * Collection type. - */ - kind?: string | null; - /** - * Link to next page for this web property collection. - */ - nextLink?: string | null; - /** - * Link to previous page for this web property collection. - */ - previousLink?: string | null; - /** - * The starting index of the resources, which is 1 by default or otherwise specified by the start-index query parameter. - */ - startIndex?: number | null; - /** - * The total number of results for the query, regardless of the number of results in the response. - */ - totalResults?: number | null; - /** - * Email ID of the authenticated user - */ - username?: string | null; - } - /** - * JSON template for an Analytics web property. - */ - export interface Schema$Webproperty { - /** - * Account ID to which this web property belongs. - */ - accountId?: string | null; - /** - * Child link for this web property. Points to the list of views (profiles) for this web property. - */ - childLink?: {href?: string; type?: string} | null; - /** - * Time this web property was created. - */ - created?: string | null; - /** - * Set to true to reset the retention period of the user identifier with each new event from that user (thus setting the expiration date to current time plus retention period). - * Set to false to delete data associated with the user identifier automatically after the rentention period. - * This property cannot be set on insert. - */ - dataRetentionResetOnNewActivity?: boolean | null; - /** - * The length of time for which user and event data is retained. - * This property cannot be set on insert. - */ - dataRetentionTtl?: string | null; - /** - * Default view (profile) ID. - */ - defaultProfileId?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY. - */ - id?: string | null; - /** - * The industry vertical/category selected for this web property. - */ - industryVertical?: string | null; - /** - * Internal ID for this web property. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for Analytics WebProperty. - */ - kind?: string | null; - /** - * Level for this web property. Possible values are STANDARD or PREMIUM. - */ - level?: string | null; - /** - * Name of this web property. - */ - name?: string | null; - /** - * Parent link for this web property. Points to the account to which this web property belongs. - */ - parentLink?: {href?: string; type?: string} | null; - /** - * Permissions the user has for this web property. - */ - permissions?: {effective?: string[]} | null; - /** - * View (Profile) count for this web property. - */ - profileCount?: number | null; - /** - * Link for this web property. - */ - selfLink?: string | null; - /** - * Indicates whether this web property is starred or not. - */ - starred?: boolean | null; - /** - * Time this web property was last modified. - */ - updated?: string | null; - /** - * Website url for this web property. - */ - websiteUrl?: string | null; - } - /** - * JSON template for a web property reference. - */ - export interface Schema$WebPropertyRef { - /** - * Account ID to which this web property belongs. - */ - accountId?: string | null; - /** - * Link for this web property. - */ - href?: string | null; - /** - * Web property ID of the form UA-XXXXX-YY. - */ - id?: string | null; - /** - * Internal ID for this web property. - */ - internalWebPropertyId?: string | null; - /** - * Analytics web property reference. - */ - kind?: string | null; - /** - * Name of this web property. - */ - name?: string | null; - } - /** - * JSON template for an Analytics WebPropertySummary. WebPropertySummary returns basic information (i.e., summary) for a web property. - */ - export interface Schema$WebPropertySummary { - /** - * Web property ID of the form UA-XXXXX-YY. - */ - id?: string | null; - /** - * Internal ID for this web property. - */ - internalWebPropertyId?: string | null; - /** - * Resource type for Analytics WebPropertySummary. - */ - kind?: string | null; - /** - * Level for this web property. Possible values are STANDARD or PREMIUM. - */ - level?: string | null; - /** - * Web property name. - */ - name?: string | null; - /** - * List of profiles under this web property. - */ - profiles?: Schema$ProfileSummary[]; - /** - * Indicates whether this web property is starred or not. - */ - starred?: boolean | null; - /** - * Website url for this web property. - */ - websiteUrl?: string | null; - } - - export class Resource$Data { - context: APIRequestContext; - ga: Resource$Data$Ga; - mcf: Resource$Data$Mcf; - realtime: Resource$Data$Realtime; - constructor(context: APIRequestContext) { - this.context = context; - this.ga = new Resource$Data$Ga(this.context); - this.mcf = new Resource$Data$Mcf(this.context); - this.realtime = new Resource$Data$Realtime(this.context); - } - } - - export class Resource$Data$Ga { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns Analytics data for a view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.data.ga.get({ - * // A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - * dimensions: '(ga:.+)?', - * // End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. - * 'end-date': '[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)', - * // A comma-separated list of dimension or metric filters to be applied to Analytics data. - * filters: 'ga:.+', - * // Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * ids: 'ga:[0-9]+', - * // The response will include empty rows if this parameter is set to true, the default is true - * 'include-empty-rows': 'placeholder-value', - * // The maximum number of entries to include in this feed. - * 'max-results': 'placeholder-value', - * // A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. - * metrics: 'ga:.+', - * // The selected format for the response. Default format is JSON. - * output: 'placeholder-value', - * // The desired sampling level. - * samplingLevel: 'placeholder-value', - * // An Analytics segment to be applied to data. - * segment: 'placeholder-value', - * // A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. - * sort: '(-)?ga:.+', - * // Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * 'start-date': '[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "columnHeaders": [], - * // "containsSampledData": false, - * // "dataLastRefreshed": "my_dataLastRefreshed", - * // "dataTable": {}, - * // "id": "my_id", - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "profileInfo": {}, - * // "query": {}, - * // "rows": [], - * // "sampleSize": "my_sampleSize", - * // "sampleSpace": "my_sampleSpace", - * // "selfLink": "my_selfLink", - * // "totalResults": 0, - * // "totalsForAllResults": {} - * // } - * } - * - * 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$Data$Ga$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Data$Ga$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Data$Ga$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Ga$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Ga$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Data$Ga$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Data$Ga$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Data$Ga$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v3/data/ga').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['ids', 'start-date', 'end-date', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Data$Ga$Get extends StandardParameters { - /** - * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - */ - dimensions?: string; - /** - * End date for fetching Analytics data. Request can should specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is yesterday. - */ - 'end-date'?: string; - /** - * A comma-separated list of dimension or metric filters to be applied to Analytics data. - */ - filters?: string; - /** - * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - */ - ids?: string; - /** - * The response will include empty rows if this parameter is set to true, the default is true - */ - 'include-empty-rows'?: boolean; - /** - * The maximum number of entries to include in this feed. - */ - 'max-results'?: number; - /** - * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified. - */ - metrics?: string; - /** - * The selected format for the response. Default format is JSON. - */ - output?: string; - /** - * The desired sampling level. - */ - samplingLevel?: string; - /** - * An Analytics segment to be applied to data. - */ - segment?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for Analytics data. - */ - sort?: string; - /** - * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - */ - 'start-date'?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Data$Mcf { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns Analytics Multi-Channel Funnels data for a view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.data.mcf.get({ - * // A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. - * dimensions: '(mcf:.+)?', - * // End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * 'end-date': '[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)', - * // A comma-separated list of dimension or metric filters to be applied to the Analytics data. - * filters: 'mcf:.+', - * // Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * ids: 'ga:[0-9]+', - * // The maximum number of entries to include in this feed. - * 'max-results': 'placeholder-value', - * // A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. - * metrics: 'mcf:.+', - * // The desired sampling level. - * samplingLevel: 'placeholder-value', - * // A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. - * sort: '(-)?mcf:.+', - * // Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - * 'start-date': '[0-9]{4}-[0-9]{2}-[0-9]{2}|today|yesterday|[0-9]+(daysAgo)', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "columnHeaders": [], - * // "containsSampledData": false, - * // "id": "my_id", - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "profileInfo": {}, - * // "query": {}, - * // "rows": [], - * // "sampleSize": "my_sampleSize", - * // "sampleSpace": "my_sampleSpace", - * // "selfLink": "my_selfLink", - * // "totalResults": 0, - * // "totalsForAllResults": {} - * // } - * } - * - * 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$Data$Mcf$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Data$Mcf$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Data$Mcf$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Mcf$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Mcf$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Data$Mcf$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || {}) as Params$Resource$Data$Mcf$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Data$Mcf$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v3/data/mcf').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['ids', 'start-date', 'end-date', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Data$Mcf$Get extends StandardParameters { - /** - * A comma-separated list of Multi-Channel Funnels dimensions. E.g., 'mcf:source,mcf:medium'. - */ - dimensions?: string; - /** - * End date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - */ - 'end-date'?: string; - /** - * A comma-separated list of dimension or metric filters to be applied to the Analytics data. - */ - filters?: string; - /** - * Unique table ID for retrieving Analytics data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - */ - ids?: string; - /** - * The maximum number of entries to include in this feed. - */ - 'max-results'?: number; - /** - * A comma-separated list of Multi-Channel Funnels metrics. E.g., 'mcf:totalConversions,mcf:totalConversionValue'. At least one metric must be specified. - */ - metrics?: string; - /** - * The desired sampling level. - */ - samplingLevel?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for the Analytics data. - */ - sort?: string; - /** - * Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or 7daysAgo). The default value is 7daysAgo. - */ - 'start-date'?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Data$Realtime { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns real time data for a view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.data.realtime.get({ - * // A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. - * dimensions: '(ga:.+)|(rt:.+)', - * // A comma-separated list of dimension or metric filters to be applied to real time data. - * filters: '(ga:.+)|(rt:.+)', - * // Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * ids: 'ga:[0-9]+', - * // The maximum number of entries to include in this feed. - * 'max-results': 'placeholder-value', - * // A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. - * metrics: '(ga:.+)|(rt:.+)', - * // A comma-separated list of dimensions or metrics that determine the sort order for real time data. - * sort: '(-)?((ga:.+)|(rt:.+))', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "columnHeaders": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileInfo": {}, - * // "query": {}, - * // "rows": [], - * // "selfLink": "my_selfLink", - * // "totalResults": 0, - * // "totalsForAllResults": {} - * // } - * } - * - * 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$Data$Realtime$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Data$Realtime$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Data$Realtime$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Realtime$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Realtime$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Data$Realtime$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Data$Realtime$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Data$Realtime$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v3/data/realtime').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['ids', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Data$Realtime$Get extends StandardParameters { - /** - * A comma-separated list of real time dimensions. E.g., 'rt:medium,rt:city'. - */ - dimensions?: string; - /** - * A comma-separated list of dimension or metric filters to be applied to real time data. - */ - filters?: string; - /** - * Unique table ID for retrieving real time data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - */ - ids?: string; - /** - * The maximum number of entries to include in this feed. - */ - 'max-results'?: number; - /** - * A comma-separated list of real time metrics. E.g., 'rt:activeUsers'. At least one metric must be specified. - */ - metrics?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for real time data. - */ - sort?: string; - } - - export class Resource$Management { - context: APIRequestContext; - accounts: Resource$Management$Accounts; - accountSummaries: Resource$Management$Accountsummaries; - accountUserLinks: Resource$Management$Accountuserlinks; - clientId: Resource$Management$Clientid; - customDataSources: Resource$Management$Customdatasources; - customDimensions: Resource$Management$Customdimensions; - customMetrics: Resource$Management$Custommetrics; - experiments: Resource$Management$Experiments; - filters: Resource$Management$Filters; - goals: Resource$Management$Goals; - profileFilterLinks: Resource$Management$Profilefilterlinks; - profiles: Resource$Management$Profiles; - profileUserLinks: Resource$Management$Profileuserlinks; - remarketingAudience: Resource$Management$Remarketingaudience; - segments: Resource$Management$Segments; - unsampledReports: Resource$Management$Unsampledreports; - uploads: Resource$Management$Uploads; - webproperties: Resource$Management$Webproperties; - webPropertyAdWordsLinks: Resource$Management$Webpropertyadwordslinks; - webpropertyUserLinks: Resource$Management$Webpropertyuserlinks; - constructor(context: APIRequestContext) { - this.context = context; - this.accounts = new Resource$Management$Accounts(this.context); - this.accountSummaries = new Resource$Management$Accountsummaries( - this.context - ); - this.accountUserLinks = new Resource$Management$Accountuserlinks( - this.context - ); - this.clientId = new Resource$Management$Clientid(this.context); - this.customDataSources = new Resource$Management$Customdatasources( - this.context - ); - this.customDimensions = new Resource$Management$Customdimensions( - this.context - ); - this.customMetrics = new Resource$Management$Custommetrics(this.context); - this.experiments = new Resource$Management$Experiments(this.context); - this.filters = new Resource$Management$Filters(this.context); - this.goals = new Resource$Management$Goals(this.context); - this.profileFilterLinks = new Resource$Management$Profilefilterlinks( - this.context - ); - this.profiles = new Resource$Management$Profiles(this.context); - this.profileUserLinks = new Resource$Management$Profileuserlinks( - this.context - ); - this.remarketingAudience = new Resource$Management$Remarketingaudience( - this.context - ); - this.segments = new Resource$Management$Segments(this.context); - this.unsampledReports = new Resource$Management$Unsampledreports( - this.context - ); - this.uploads = new Resource$Management$Uploads(this.context); - this.webproperties = new Resource$Management$Webproperties(this.context); - this.webPropertyAdWordsLinks = - new Resource$Management$Webpropertyadwordslinks(this.context); - this.webpropertyUserLinks = new Resource$Management$Webpropertyuserlinks( - this.context - ); - } - } - - export class Resource$Management$Accounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists all accounts to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.accounts.list({ - * // The maximum number of accounts to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Accounts$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Accounts$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Accounts$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accounts$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accounts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Accounts$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v3/management/accounts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Accounts$List extends StandardParameters { - /** - * The maximum number of accounts to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management$Accountsummaries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.accountSummaries.list({ - * // The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Accountsummaries$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Accountsummaries$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Accountsummaries$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accountsummaries$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accountsummaries$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Accountsummaries$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accountsummaries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accountsummaries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/management/accountSummaries' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Accountsummaries$List extends StandardParameters { - /** - * The maximum number of account summaries to include in this response, where the largest acceptable value is 1000. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management$Accountuserlinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Removes a user from the given account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.accountUserLinks.delete({ - * // Account ID to delete the user link for. - * accountId: 'placeholder-value', - * // Link ID to delete the user link for. - * linkId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Accountuserlinks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Accountuserlinks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Accountuserlinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Accountuserlinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Accountuserlinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Accountuserlinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accountuserlinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accountuserlinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'linkId'], - pathParams: ['accountId', 'linkId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Adds a new user to the given account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.accountUserLinks.insert({ - * // Account ID to create the user link for. - * accountId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Accountuserlinks$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Accountuserlinks$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Accountuserlinks$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Accountuserlinks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Accountuserlinks$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Accountuserlinks$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accountuserlinks$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accountuserlinks$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists account-user links for a given account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users', - * 'https://www.googleapis.com/auth/analytics.manage.users.readonly', - * ], - * }); - * - * // 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 analytics.management.accountUserLinks.list({ - * // Account ID to retrieve the user links for. - * accountId: 'placeholder-value', - * // The maximum number of account-user links to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 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. - */ - list( - params: Params$Resource$Management$Accountuserlinks$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Accountuserlinks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Accountuserlinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accountuserlinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accountuserlinks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Accountuserlinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accountuserlinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accountuserlinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates permissions for an existing user on the given account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.accountUserLinks.update({ - * // Account ID to update the account-user link for. - * accountId: 'placeholder-value', - * // Link ID to update the account-user link for. - * linkId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Accountuserlinks$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Accountuserlinks$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Accountuserlinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Accountuserlinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Accountuserlinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Accountuserlinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accountuserlinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accountuserlinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'linkId'], - pathParams: ['accountId', 'linkId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Accountuserlinks$Delete extends StandardParameters { - /** - * Account ID to delete the user link for. - */ - accountId?: string; - /** - * Link ID to delete the user link for. - */ - linkId?: string; - } - export interface Params$Resource$Management$Accountuserlinks$Insert extends StandardParameters { - /** - * Account ID to create the user link for. - */ - accountId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - export interface Params$Resource$Management$Accountuserlinks$List extends StandardParameters { - /** - * Account ID to retrieve the user links for. - */ - accountId?: string; - /** - * The maximum number of account-user links to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first account-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - export interface Params$Resource$Management$Accountuserlinks$Update extends StandardParameters { - /** - * Account ID to update the account-user link for. - */ - accountId?: string; - /** - * Link ID to update the account-user link for. - */ - linkId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - - export class Resource$Management$Clientid { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Hashes the given Client ID. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.clientId.hashClientId({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "clientId": "my_clientId", - * // "kind": "my_kind", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "clientId": "my_clientId", - * // "hashedClientId": "my_hashedClientId", - * // "kind": "my_kind", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - hashClientId( - params: Params$Resource$Management$Clientid$Hashclientid, - options: StreamMethodOptions - ): Promise>; - hashClientId( - params?: Params$Resource$Management$Clientid$Hashclientid, - options?: MethodOptions - ): Promise>; - hashClientId( - params: Params$Resource$Management$Clientid$Hashclientid, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - hashClientId( - params: Params$Resource$Management$Clientid$Hashclientid, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - hashClientId( - params: Params$Resource$Management$Clientid$Hashclientid, - callback: BodyResponseCallback - ): void; - hashClientId( - callback: BodyResponseCallback - ): void; - hashClientId( - paramsOrCallback?: - | Params$Resource$Management$Clientid$Hashclientid - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Clientid$Hashclientid; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Clientid$Hashclientid; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/management/clientId:hashClientId' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Clientid$Hashclientid extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$HashClientIdRequest; - } - - export class Resource$Management$Customdatasources { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * List custom data sources to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.customDataSources.list({ - * // Account Id for the custom data sources to retrieve. - * accountId: '\d+', - * // The maximum number of custom data sources to include in this response. - * 'max-results': 'placeholder-value', - * // A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property Id for the custom data sources to retrieve. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Customdatasources$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Customdatasources$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Customdatasources$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Customdatasources$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Customdatasources$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Customdatasources$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdatasources$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdatasources$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Customdatasources$List extends StandardParameters { - /** - * Account Id for the custom data sources to retrieve. - */ - accountId?: string; - /** - * The maximum number of custom data sources to include in this response. - */ - 'max-results'?: number; - /** - * A 1-based index of the first custom data source to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property Id for the custom data sources to retrieve. - */ - webPropertyId?: string; - } - - export class Resource$Management$Customdimensions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Get a custom dimension to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.customDimensions.get({ - * // Account ID for the custom dimension to retrieve. - * accountId: 'placeholder-value', - * // The ID of the custom dimension to retrieve. - * customDimensionId: 'placeholder-value', - * // Web property ID for the custom dimension to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Customdimensions$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Customdimensions$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Customdimensions$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Customdimensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Customdimensions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Customdimensions$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdimensions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdimensions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customDimensionId'], - pathParams: ['accountId', 'customDimensionId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new custom dimension. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customDimensions.insert({ - * // Account ID for the custom dimension to create. - * accountId: 'placeholder-value', - * // Web property ID for the custom dimension to create. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Customdimensions$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Customdimensions$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Customdimensions$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Customdimensions$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Customdimensions$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Customdimensions$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdimensions$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdimensions$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists custom dimensions to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.customDimensions.list({ - * // Account ID for the custom dimensions to retrieve. - * accountId: 'placeholder-value', - * // The maximum number of custom dimensions to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID for the custom dimensions to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Customdimensions$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Customdimensions$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Customdimensions$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Customdimensions$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Customdimensions$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Customdimensions$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdimensions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdimensions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing custom dimension. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customDimensions.patch({ - * // Account ID for the custom dimension to update. - * accountId: 'placeholder-value', - * // Custom dimension ID for the custom dimension to update. - * customDimensionId: 'placeholder-value', - * // Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - * ignoreCustomDataSourceLinks: 'placeholder-value', - * // Web property ID for the custom dimension to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Customdimensions$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Customdimensions$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Customdimensions$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Customdimensions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Customdimensions$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Customdimensions$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdimensions$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdimensions$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customDimensionId'], - pathParams: ['accountId', 'customDimensionId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing custom dimension. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customDimensions.update({ - * // Account ID for the custom dimension to update. - * accountId: 'placeholder-value', - * // Custom dimension ID for the custom dimension to update. - * customDimensionId: 'placeholder-value', - * // Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - * ignoreCustomDataSourceLinks: 'placeholder-value', - * // Web property ID for the custom dimension to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Customdimensions$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Customdimensions$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Customdimensions$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Customdimensions$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Customdimensions$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Customdimensions$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Customdimensions$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Customdimensions$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDimensions/{customDimensionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customDimensionId'], - pathParams: ['accountId', 'customDimensionId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Customdimensions$Get extends StandardParameters { - /** - * Account ID for the custom dimension to retrieve. - */ - accountId?: string; - /** - * The ID of the custom dimension to retrieve. - */ - customDimensionId?: string; - /** - * Web property ID for the custom dimension to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Customdimensions$Insert extends StandardParameters { - /** - * Account ID for the custom dimension to create. - */ - accountId?: string; - /** - * Web property ID for the custom dimension to create. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomDimension; - } - export interface Params$Resource$Management$Customdimensions$List extends StandardParameters { - /** - * Account ID for the custom dimensions to retrieve. - */ - accountId?: string; - /** - * The maximum number of custom dimensions to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID for the custom dimensions to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Customdimensions$Patch extends StandardParameters { - /** - * Account ID for the custom dimension to update. - */ - accountId?: string; - /** - * Custom dimension ID for the custom dimension to update. - */ - customDimensionId?: string; - /** - * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - */ - ignoreCustomDataSourceLinks?: boolean; - /** - * Web property ID for the custom dimension to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomDimension; - } - export interface Params$Resource$Management$Customdimensions$Update extends StandardParameters { - /** - * Account ID for the custom dimension to update. - */ - accountId?: string; - /** - * Custom dimension ID for the custom dimension to update. - */ - customDimensionId?: string; - /** - * Force the update and ignore any warnings related to the custom dimension being linked to a custom data source / data set. - */ - ignoreCustomDataSourceLinks?: boolean; - /** - * Web property ID for the custom dimension to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomDimension; - } - - export class Resource$Management$Custommetrics { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Get a custom metric to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.customMetrics.get({ - * // Account ID for the custom metric to retrieve. - * accountId: 'placeholder-value', - * // The ID of the custom metric to retrieve. - * customMetricId: 'placeholder-value', - * // Web property ID for the custom metric to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Custommetrics$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Custommetrics$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Custommetrics$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Custommetrics$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Custommetrics$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Custommetrics$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Custommetrics$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Custommetrics$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customMetricId'], - pathParams: ['accountId', 'customMetricId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new custom metric. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customMetrics.insert({ - * // Account ID for the custom metric to create. - * accountId: 'placeholder-value', - * // Web property ID for the custom dimension to create. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Custommetrics$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Custommetrics$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Custommetrics$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Custommetrics$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Custommetrics$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Custommetrics$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Custommetrics$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Custommetrics$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists custom metrics to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.customMetrics.list({ - * // Account ID for the custom metrics to retrieve. - * accountId: 'placeholder-value', - * // The maximum number of custom metrics to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID for the custom metrics to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Custommetrics$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Custommetrics$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Custommetrics$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Custommetrics$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Custommetrics$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Custommetrics$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Custommetrics$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Custommetrics$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing custom metric. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customMetrics.patch({ - * // Account ID for the custom metric to update. - * accountId: 'placeholder-value', - * // Custom metric ID for the custom metric to update. - * customMetricId: 'placeholder-value', - * // Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - * ignoreCustomDataSourceLinks: 'placeholder-value', - * // Web property ID for the custom metric to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Custommetrics$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Custommetrics$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Custommetrics$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Custommetrics$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Custommetrics$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Custommetrics$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Custommetrics$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Custommetrics$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customMetricId'], - pathParams: ['accountId', 'customMetricId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing custom metric. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.customMetrics.update({ - * // Account ID for the custom metric to update. - * accountId: 'placeholder-value', - * // Custom metric ID for the custom metric to update. - * customMetricId: 'placeholder-value', - * // Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - * ignoreCustomDataSourceLinks: 'placeholder-value', - * // Web property ID for the custom metric to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "id": "my_id", - * // "index": 0, - * // "kind": "my_kind", - * // "max_value": "my_max_value", - * // "min_value": "my_min_value", - * // "name": "my_name", - * // "parentLink": {}, - * // "scope": "my_scope", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Custommetrics$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Custommetrics$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Custommetrics$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Custommetrics$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Custommetrics$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Custommetrics$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Custommetrics$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Custommetrics$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customMetrics/{customMetricId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customMetricId'], - pathParams: ['accountId', 'customMetricId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Custommetrics$Get extends StandardParameters { - /** - * Account ID for the custom metric to retrieve. - */ - accountId?: string; - /** - * The ID of the custom metric to retrieve. - */ - customMetricId?: string; - /** - * Web property ID for the custom metric to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Custommetrics$Insert extends StandardParameters { - /** - * Account ID for the custom metric to create. - */ - accountId?: string; - /** - * Web property ID for the custom dimension to create. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomMetric; - } - export interface Params$Resource$Management$Custommetrics$List extends StandardParameters { - /** - * Account ID for the custom metrics to retrieve. - */ - accountId?: string; - /** - * The maximum number of custom metrics to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID for the custom metrics to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Custommetrics$Patch extends StandardParameters { - /** - * Account ID for the custom metric to update. - */ - accountId?: string; - /** - * Custom metric ID for the custom metric to update. - */ - customMetricId?: string; - /** - * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - */ - ignoreCustomDataSourceLinks?: boolean; - /** - * Web property ID for the custom metric to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomMetric; - } - export interface Params$Resource$Management$Custommetrics$Update extends StandardParameters { - /** - * Account ID for the custom metric to update. - */ - accountId?: string; - /** - * Custom metric ID for the custom metric to update. - */ - customMetricId?: string; - /** - * Force the update and ignore any warnings related to the custom metric being linked to a custom data source / data set. - */ - ignoreCustomDataSourceLinks?: boolean; - /** - * Web property ID for the custom metric to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CustomMetric; - } - - export class Resource$Management$Experiments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Delete an experiment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.experiments.delete({ - * // Account ID to which the experiment belongs - * accountId: 'placeholder-value', - * // ID of the experiment to delete - * experimentId: 'placeholder-value', - * // View (Profile) ID to which the experiment belongs - * profileId: 'placeholder-value', - * // Web property ID to which the experiment belongs - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Experiments$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Experiments$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Experiments$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Experiments$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Experiments$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Experiments$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'experimentId', - ], - pathParams: ['accountId', 'experimentId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns an experiment to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.experiments.get({ - * // Account ID to retrieve the experiment for. - * accountId: 'placeholder-value', - * // Experiment ID to retrieve the experiment for. - * experimentId: 'placeholder-value', - * // View (Profile) ID to retrieve the experiment for. - * profileId: 'placeholder-value', - * // Web property ID to retrieve the experiment for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": 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. - */ - get( - params: Params$Resource$Management$Experiments$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Experiments$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Experiments$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Experiments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Experiments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Experiments$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'experimentId', - ], - pathParams: ['accountId', 'experimentId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new experiment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.experiments.insert({ - * // Account ID to create the experiment for. - * accountId: 'placeholder-value', - * // View (Profile) ID to create the experiment for. - * profileId: 'placeholder-value', - * // Web property ID to create the experiment for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": 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. - */ - insert( - params: Params$Resource$Management$Experiments$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Experiments$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Experiments$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Experiments$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Experiments$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Experiments$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists experiments to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.experiments.list({ - * // Account ID to retrieve experiments for. - * accountId: '\d+', - * // The maximum number of experiments to include in this response. - * 'max-results': 'placeholder-value', - * // View (Profile) ID to retrieve experiments for. - * profileId: '\d+', - * // An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID to retrieve experiments for. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Experiments$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Experiments$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Experiments$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Experiments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Experiments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Experiments$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Update an existing experiment. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.experiments.patch({ - * // Account ID of the experiment to update. - * accountId: 'placeholder-value', - * // Experiment ID of the experiment to update. - * experimentId: 'placeholder-value', - * // View (Profile) ID of the experiment to update. - * profileId: 'placeholder-value', - * // Web property ID of the experiment to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": 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. - */ - patch( - params: Params$Resource$Management$Experiments$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Experiments$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Experiments$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Experiments$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Experiments$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Experiments$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'experimentId', - ], - pathParams: ['accountId', 'experimentId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Update an existing experiment. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.experiments.update({ - * // Account ID of the experiment to update. - * accountId: 'placeholder-value', - * // Experiment ID of the experiment to update. - * experimentId: 'placeholder-value', - * // View (Profile) ID of the experiment to update. - * profileId: 'placeholder-value', - * // Web property ID of the experiment to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "created": "my_created", - * // "description": "my_description", - * // "editableInGaUi": false, - * // "endTime": "my_endTime", - * // "equalWeighting": false, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "minimumExperimentLengthInDays": 0, - * // "name": "my_name", - * // "objectiveMetric": "my_objectiveMetric", - * // "optimizationType": "my_optimizationType", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "reasonExperimentEnded": "my_reasonExperimentEnded", - * // "rewriteVariationUrlsAsOriginal": false, - * // "selfLink": "my_selfLink", - * // "servingFramework": "my_servingFramework", - * // "snippet": "my_snippet", - * // "startTime": "my_startTime", - * // "status": "my_status", - * // "trafficCoverage": {}, - * // "updated": "my_updated", - * // "variations": [], - * // "webPropertyId": "my_webPropertyId", - * // "winnerConfidenceLevel": {}, - * // "winnerFound": 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. - */ - update( - params: Params$Resource$Management$Experiments$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Experiments$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Experiments$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Experiments$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Experiments$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Experiments$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Experiments$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Experiments$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/experiments/{experimentId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'experimentId', - ], - pathParams: ['accountId', 'experimentId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Experiments$Delete extends StandardParameters { - /** - * Account ID to which the experiment belongs - */ - accountId?: string; - /** - * ID of the experiment to delete - */ - experimentId?: string; - /** - * View (Profile) ID to which the experiment belongs - */ - profileId?: string; - /** - * Web property ID to which the experiment belongs - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Experiments$Get extends StandardParameters { - /** - * Account ID to retrieve the experiment for. - */ - accountId?: string; - /** - * Experiment ID to retrieve the experiment for. - */ - experimentId?: string; - /** - * View (Profile) ID to retrieve the experiment for. - */ - profileId?: string; - /** - * Web property ID to retrieve the experiment for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Experiments$Insert extends StandardParameters { - /** - * Account ID to create the experiment for. - */ - accountId?: string; - /** - * View (Profile) ID to create the experiment for. - */ - profileId?: string; - /** - * Web property ID to create the experiment for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Experiment; - } - export interface Params$Resource$Management$Experiments$List extends StandardParameters { - /** - * Account ID to retrieve experiments for. - */ - accountId?: string; - /** - * The maximum number of experiments to include in this response. - */ - 'max-results'?: number; - /** - * View (Profile) ID to retrieve experiments for. - */ - profileId?: string; - /** - * An index of the first experiment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID to retrieve experiments for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Experiments$Patch extends StandardParameters { - /** - * Account ID of the experiment to update. - */ - accountId?: string; - /** - * Experiment ID of the experiment to update. - */ - experimentId?: string; - /** - * View (Profile) ID of the experiment to update. - */ - profileId?: string; - /** - * Web property ID of the experiment to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Experiment; - } - export interface Params$Resource$Management$Experiments$Update extends StandardParameters { - /** - * Account ID of the experiment to update. - */ - accountId?: string; - /** - * Experiment ID of the experiment to update. - */ - experimentId?: string; - /** - * View (Profile) ID of the experiment to update. - */ - profileId?: string; - /** - * Web property ID of the experiment to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Experiment; - } - - export class Resource$Management$Filters { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Delete a filter. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.filters.delete({ - * // Account ID to delete the filter for. - * accountId: 'placeholder-value', - * // ID of the filter to be deleted. - * filterId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * } - * - * 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$Management$Filters$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Filters$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Filters$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Filters$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Filters$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Filters$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/filters/{filterId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'filterId'], - pathParams: ['accountId', 'filterId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns filters to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.filters.get({ - * // Account ID to retrieve filters for. - * accountId: 'placeholder-value', - * // Filter ID to retrieve filters for. - * filterId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * } - * - * 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$Management$Filters$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Filters$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Filters$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Filters$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Filters$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Filters$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/filters/{filterId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'filterId'], - pathParams: ['accountId', 'filterId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new filter. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.filters.insert({ - * // Account ID to create filter for. - * accountId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Filters$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Filters$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Filters$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Filters$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Filters$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Filters$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/management/accounts/{accountId}/filters' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists all filters for an account - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.filters.list({ - * // Account ID to retrieve filters for. - * accountId: '\d+', - * // The maximum number of filters to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Filters$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Filters$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Filters$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Filters$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Filters$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Filters$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/management/accounts/{accountId}/filters' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing filter. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.filters.patch({ - * // Account ID to which the filter belongs. - * accountId: 'placeholder-value', - * // ID of the filter to be updated. - * filterId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * } - * - * 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$Management$Filters$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Filters$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Filters$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Filters$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Filters$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Filters$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/filters/{filterId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'filterId'], - pathParams: ['accountId', 'filterId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing filter. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.filters.update({ - * // Account ID to which the filter belongs. - * accountId: 'placeholder-value', - * // ID of the filter to be updated. - * filterId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "advancedDetails": {}, - * // "created": "my_created", - * // "excludeDetails": {}, - * // "id": "my_id", - * // "includeDetails": {}, - * // "kind": "my_kind", - * // "lowercaseDetails": {}, - * // "name": "my_name", - * // "parentLink": {}, - * // "searchAndReplaceDetails": {}, - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "uppercaseDetails": {} - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Filters$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Filters$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Filters$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Filters$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Filters$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Filters$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Filters$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Filters$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/filters/{filterId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'filterId'], - pathParams: ['accountId', 'filterId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Filters$Delete extends StandardParameters { - /** - * Account ID to delete the filter for. - */ - accountId?: string; - /** - * ID of the filter to be deleted. - */ - filterId?: string; - } - export interface Params$Resource$Management$Filters$Get extends StandardParameters { - /** - * Account ID to retrieve filters for. - */ - accountId?: string; - /** - * Filter ID to retrieve filters for. - */ - filterId?: string; - } - export interface Params$Resource$Management$Filters$Insert extends StandardParameters { - /** - * Account ID to create filter for. - */ - accountId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Filter; - } - export interface Params$Resource$Management$Filters$List extends StandardParameters { - /** - * Account ID to retrieve filters for. - */ - accountId?: string; - /** - * The maximum number of filters to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - export interface Params$Resource$Management$Filters$Patch extends StandardParameters { - /** - * Account ID to which the filter belongs. - */ - accountId?: string; - /** - * ID of the filter to be updated. - */ - filterId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Filter; - } - export interface Params$Resource$Management$Filters$Update extends StandardParameters { - /** - * Account ID to which the filter belongs. - */ - accountId?: string; - /** - * ID of the filter to be updated. - */ - filterId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Filter; - } - - export class Resource$Management$Goals { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a goal to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.goals.get({ - * // Account ID to retrieve the goal for. - * accountId: 'placeholder-value', - * // Goal ID to retrieve the goal for. - * goalId: 'placeholder-value', - * // View (Profile) ID to retrieve the goal for. - * profileId: 'placeholder-value', - * // Web property ID to retrieve the goal for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Goals$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Goals$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Goals$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Goals$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Goals$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Goals$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'goalId'], - pathParams: ['accountId', 'goalId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new goal. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.goals.insert({ - * // Account ID to create the goal for. - * accountId: 'placeholder-value', - * // View (Profile) ID to create the goal for. - * profileId: 'placeholder-value', - * // Web property ID to create the goal for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Goals$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Goals$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Goals$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Goals$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Goals$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Goals$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists goals to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.goals.list({ - * // Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * accountId: 'placeholder-value', - * // The maximum number of goals to include in this response. - * 'max-results': 'placeholder-value', - * // View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - * profileId: 'placeholder-value', - * // An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Goals$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Goals$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Goals$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Goals$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Goals$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Goals$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing goal. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.goals.patch({ - * // Account ID to update the goal. - * accountId: 'placeholder-value', - * // Index of the goal to be updated. - * goalId: 'placeholder-value', - * // View (Profile) ID to update the goal. - * profileId: 'placeholder-value', - * // Web property ID to update the goal. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Goals$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Goals$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Goals$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Goals$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Goals$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Goals$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'goalId'], - pathParams: ['accountId', 'goalId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing goal. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.goals.update({ - * // Account ID to update the goal. - * accountId: 'placeholder-value', - * // Index of the goal to be updated. - * goalId: 'placeholder-value', - * // View (Profile) ID to update the goal. - * profileId: 'placeholder-value', - * // Web property ID to update the goal. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "active": false, - * // "created": "my_created", - * // "eventDetails": {}, - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "profileId": "my_profileId", - * // "selfLink": "my_selfLink", - * // "type": "my_type", - * // "updated": "my_updated", - * // "urlDestinationDetails": {}, - * // "value": {}, - * // "visitNumPagesDetails": {}, - * // "visitTimeOnSiteDetails": {}, - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Goals$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Goals$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Goals$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Goals$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Goals$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Goals$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals/{goalId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'goalId'], - pathParams: ['accountId', 'goalId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Goals$Get extends StandardParameters { - /** - * Account ID to retrieve the goal for. - */ - accountId?: string; - /** - * Goal ID to retrieve the goal for. - */ - goalId?: string; - /** - * View (Profile) ID to retrieve the goal for. - */ - profileId?: string; - /** - * Web property ID to retrieve the goal for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Goals$Insert extends StandardParameters { - /** - * Account ID to create the goal for. - */ - accountId?: string; - /** - * View (Profile) ID to create the goal for. - */ - profileId?: string; - /** - * Web property ID to create the goal for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Goal; - } - export interface Params$Resource$Management$Goals$List extends StandardParameters { - /** - * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - */ - accountId?: string; - /** - * The maximum number of goals to include in this response. - */ - 'max-results'?: number; - /** - * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - */ - profileId?: string; - /** - * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Goals$Patch extends StandardParameters { - /** - * Account ID to update the goal. - */ - accountId?: string; - /** - * Index of the goal to be updated. - */ - goalId?: string; - /** - * View (Profile) ID to update the goal. - */ - profileId?: string; - /** - * Web property ID to update the goal. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Goal; - } - export interface Params$Resource$Management$Goals$Update extends StandardParameters { - /** - * Account ID to update the goal. - */ - accountId?: string; - /** - * Index of the goal to be updated. - */ - goalId?: string; - /** - * View (Profile) ID to update the goal. - */ - profileId?: string; - /** - * Web property ID to update the goal. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Goal; - } - - export class Resource$Management$Profilefilterlinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Delete a profile filter link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profileFilterLinks.delete({ - * // Account ID to which the profile filter link belongs. - * accountId: '\d+', - * // ID of the profile filter link to delete. - * linkId: '\d+:\d+', - * // Profile ID to which the filter link belongs. - * profileId: '\d+', - * // Web property Id to which the profile filter link belongs. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * } - * - * 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$Management$Profilefilterlinks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Profilefilterlinks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Profilefilterlinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profilefilterlinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profilefilterlinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns a single profile filter link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.profileFilterLinks.get({ - * // Account ID to retrieve profile filter link for. - * accountId: '\d+', - * // ID of the profile filter link. - * linkId: '\d+:\d+', - * // Profile ID to retrieve filter link for. - * profileId: '\d+', - * // Web property Id to retrieve profile filter link for. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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$Management$Profilefilterlinks$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Profilefilterlinks$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Profilefilterlinks$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Profilefilterlinks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Profilefilterlinks$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new profile filter link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profileFilterLinks.insert({ - * // Account ID to create profile filter link for. - * accountId: '\d+', - * // Profile ID to create filter link for. - * profileId: '\d+', - * // Web property Id to create profile filter link for. - * webPropertyId: 'UA-(\d+)-(\d+)', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Profilefilterlinks$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Profilefilterlinks$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Profilefilterlinks$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profilefilterlinks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profilefilterlinks$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists all profile filter links for a profile. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.profileFilterLinks.list({ - * // Account ID to retrieve profile filter links for. - * accountId: '\d+', - * // The maximum number of profile filter links to include in this response. - * 'max-results': 'placeholder-value', - * // Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - * profileId: 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Profilefilterlinks$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Profilefilterlinks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Profilefilterlinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profilefilterlinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profilefilterlinks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Update an existing profile filter link. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profileFilterLinks.patch({ - * // Account ID to which profile filter link belongs. - * accountId: '\d+', - * // ID of the profile filter link to be updated. - * linkId: '\d+:\d+', - * // Profile ID to which filter link belongs - * profileId: '\d+', - * // Web property Id to which profile filter link belongs - * webPropertyId: 'UA-(\d+)-(\d+)', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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$Management$Profilefilterlinks$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Profilefilterlinks$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Profilefilterlinks$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Profilefilterlinks$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Profilefilterlinks$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Update an existing profile filter link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profileFilterLinks.update({ - * // Account ID to which profile filter link belongs. - * accountId: '\d+', - * // ID of the profile filter link to be updated. - * linkId: '\d+:\d+', - * // Profile ID to which filter link belongs - * profileId: '\d+', - * // Web property Id to which profile filter link belongs - * webPropertyId: 'UA-(\d+)-(\d+)', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "filterRef": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profileRef": {}, - * // "rank": 0, - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Profilefilterlinks$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Profilefilterlinks$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Profilefilterlinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profilefilterlinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profilefilterlinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Profilefilterlinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profilefilterlinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profilefilterlinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/profileFilterLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Profilefilterlinks$Delete extends StandardParameters { - /** - * Account ID to which the profile filter link belongs. - */ - accountId?: string; - /** - * ID of the profile filter link to delete. - */ - linkId?: string; - /** - * Profile ID to which the filter link belongs. - */ - profileId?: string; - /** - * Web property Id to which the profile filter link belongs. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profilefilterlinks$Get extends StandardParameters { - /** - * Account ID to retrieve profile filter link for. - */ - accountId?: string; - /** - * ID of the profile filter link. - */ - linkId?: string; - /** - * Profile ID to retrieve filter link for. - */ - profileId?: string; - /** - * Web property Id to retrieve profile filter link for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profilefilterlinks$Insert extends StandardParameters { - /** - * Account ID to create profile filter link for. - */ - accountId?: string; - /** - * Profile ID to create filter link for. - */ - profileId?: string; - /** - * Web property Id to create profile filter link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProfileFilterLink; - } - export interface Params$Resource$Management$Profilefilterlinks$List extends StandardParameters { - /** - * Account ID to retrieve profile filter links for. - */ - accountId?: string; - /** - * The maximum number of profile filter links to include in this response. - */ - 'max-results'?: number; - /** - * Profile ID to retrieve filter links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - */ - profileId?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property Id for profile filter links for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profilefilterlinks$Patch extends StandardParameters { - /** - * Account ID to which profile filter link belongs. - */ - accountId?: string; - /** - * ID of the profile filter link to be updated. - */ - linkId?: string; - /** - * Profile ID to which filter link belongs - */ - profileId?: string; - /** - * Web property Id to which profile filter link belongs - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProfileFilterLink; - } - export interface Params$Resource$Management$Profilefilterlinks$Update extends StandardParameters { - /** - * Account ID to which profile filter link belongs. - */ - accountId?: string; - /** - * ID of the profile filter link to be updated. - */ - linkId?: string; - /** - * Profile ID to which filter link belongs - */ - profileId?: string; - /** - * Web property Id to which profile filter link belongs - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ProfileFilterLink; - } - - export class Resource$Management$Profiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profiles.delete({ - * // Account ID to delete the view (profile) for. - * accountId: 'placeholder-value', - * // ID of the view (profile) to be deleted. - * profileId: 'placeholder-value', - * // Web property ID to delete the view (profile) for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Profiles$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Profiles$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Profiles$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profiles$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profiles$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Profiles$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets a view (profile) to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.profiles.get({ - * // Account ID to retrieve the view (profile) for. - * accountId: '[0-9]+', - * // View (Profile) ID to retrieve the view (profile) for. - * profileId: '[0-9]+', - * // Web property ID to retrieve the view (profile) for. - * webPropertyId: 'UA-[0-9]+-[0-9]+', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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$Management$Profiles$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Profiles$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Profiles$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Profiles$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Profiles$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Profiles$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profiles.insert({ - * // Account ID to create the view (profile) for. - * accountId: 'placeholder-value', - * // Web property ID to create the view (profile) for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Profiles$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Profiles$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Profiles$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profiles$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profiles$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Profiles$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists views (profiles) to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.profiles.list({ - * // Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - * accountId: 'placeholder-value', - * // The maximum number of views (profiles) to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Profiles$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Profiles$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Profiles$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profiles$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profiles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Profiles$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing view (profile). This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profiles.patch({ - * // Account ID to which the view (profile) belongs - * accountId: 'placeholder-value', - * // ID of the view (profile) to be updated. - * profileId: 'placeholder-value', - * // Web property ID to which the view (profile) belongs - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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$Management$Profiles$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Profiles$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Profiles$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Profiles$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Profiles$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Profiles$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.profiles.update({ - * // Account ID to which the view (profile) belongs - * accountId: 'placeholder-value', - * // ID of the view (profile) to be updated. - * profileId: 'placeholder-value', - * // Web property ID to which the view (profile) belongs - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "botFilteringEnabled": false, - * // "childLink": {}, - * // "created": "my_created", - * // "currency": "my_currency", - * // "defaultPage": "my_defaultPage", - * // "eCommerceTracking": false, - * // "enhancedECommerceTracking": false, - * // "excludeQueryParameters": "my_excludeQueryParameters", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "siteSearchCategoryParameters": "my_siteSearchCategoryParameters", - * // "siteSearchQueryParameters": "my_siteSearchQueryParameters", - * // "starred": false, - * // "stripSiteSearchCategoryParameters": false, - * // "stripSiteSearchQueryParameters": false, - * // "timezone": "my_timezone", - * // "type": "my_type", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Profiles$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Profiles$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Profiles$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profiles$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profiles$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Profiles$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Profiles$Delete extends StandardParameters { - /** - * Account ID to delete the view (profile) for. - */ - accountId?: string; - /** - * ID of the view (profile) to be deleted. - */ - profileId?: string; - /** - * Web property ID to delete the view (profile) for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profiles$Get extends StandardParameters { - /** - * Account ID to retrieve the view (profile) for. - */ - accountId?: string; - /** - * View (Profile) ID to retrieve the view (profile) for. - */ - profileId?: string; - /** - * Web property ID to retrieve the view (profile) for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profiles$Insert extends StandardParameters { - /** - * Account ID to create the view (profile) for. - */ - accountId?: string; - /** - * Web property ID to create the view (profile) for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Profile; - } - export interface Params$Resource$Management$Profiles$List extends StandardParameters { - /** - * Account ID for the view (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - */ - accountId?: string; - /** - * The maximum number of views (profiles) to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profiles$Patch extends StandardParameters { - /** - * Account ID to which the view (profile) belongs - */ - accountId?: string; - /** - * ID of the view (profile) to be updated. - */ - profileId?: string; - /** - * Web property ID to which the view (profile) belongs - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Profile; - } - export interface Params$Resource$Management$Profiles$Update extends StandardParameters { - /** - * Account ID to which the view (profile) belongs - */ - accountId?: string; - /** - * ID of the view (profile) to be updated. - */ - profileId?: string; - /** - * Web property ID to which the view (profile) belongs - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Profile; - } - - export class Resource$Management$Profileuserlinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Removes a user from the given view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.profileUserLinks.delete({ - * // Account ID to delete the user link for. - * accountId: 'placeholder-value', - * // Link ID to delete the user link for. - * linkId: 'placeholder-value', - * // View (Profile) ID to delete the user link for. - * profileId: 'placeholder-value', - * // Web Property ID to delete the user link for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Profileuserlinks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Profileuserlinks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Profileuserlinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profileuserlinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Profileuserlinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Profileuserlinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profileuserlinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profileuserlinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Adds a new user to the given view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.profileUserLinks.insert({ - * // Account ID to create the user link for. - * accountId: 'placeholder-value', - * // View (Profile) ID to create the user link for. - * profileId: 'placeholder-value', - * // Web Property ID to create the user link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Profileuserlinks$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Profileuserlinks$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Profileuserlinks$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profileuserlinks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Profileuserlinks$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Profileuserlinks$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profileuserlinks$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profileuserlinks$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists profile-user links for a given view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users', - * 'https://www.googleapis.com/auth/analytics.manage.users.readonly', - * ], - * }); - * - * // 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 analytics.management.profileUserLinks.list({ - * // Account ID which the given view (profile) belongs to. - * accountId: 'placeholder-value', - * // The maximum number of profile-user links to include in this response. - * 'max-results': 'placeholder-value', - * // View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - * profileId: 'placeholder-value', - * // An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 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. - */ - list( - params: Params$Resource$Management$Profileuserlinks$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Profileuserlinks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Profileuserlinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profileuserlinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profileuserlinks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Profileuserlinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profileuserlinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profileuserlinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates permissions for an existing user on the given view (profile). - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.profileUserLinks.update({ - * // Account ID to update the user link for. - * accountId: 'placeholder-value', - * // Link ID to update the user link for. - * linkId: 'placeholder-value', - * // View (Profile ID) to update the user link for. - * profileId: 'placeholder-value', - * // Web Property ID to update the user link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Profileuserlinks$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Profileuserlinks$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Profileuserlinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profileuserlinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Profileuserlinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Profileuserlinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profileuserlinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profileuserlinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId', 'linkId'], - pathParams: ['accountId', 'linkId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Profileuserlinks$Delete extends StandardParameters { - /** - * Account ID to delete the user link for. - */ - accountId?: string; - /** - * Link ID to delete the user link for. - */ - linkId?: string; - /** - * View (Profile) ID to delete the user link for. - */ - profileId?: string; - /** - * Web Property ID to delete the user link for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profileuserlinks$Insert extends StandardParameters { - /** - * Account ID to create the user link for. - */ - accountId?: string; - /** - * View (Profile) ID to create the user link for. - */ - profileId?: string; - /** - * Web Property ID to create the user link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - export interface Params$Resource$Management$Profileuserlinks$List extends StandardParameters { - /** - * Account ID which the given view (profile) belongs to. - */ - accountId?: string; - /** - * The maximum number of profile-user links to include in this response. - */ - 'max-results'?: number; - /** - * View (Profile) ID to retrieve the profile-user links for. Can either be a specific profile ID or '~all', which refers to all the profiles that user has access to. - */ - profileId?: string; - /** - * An index of the first profile-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web Property ID which the given view (profile) belongs to. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Profileuserlinks$Update extends StandardParameters { - /** - * Account ID to update the user link for. - */ - accountId?: string; - /** - * Link ID to update the user link for. - */ - linkId?: string; - /** - * View (Profile ID) to update the user link for. - */ - profileId?: string; - /** - * Web Property ID to update the user link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - - export class Resource$Management$Remarketingaudience { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Delete a remarketing audience. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.remarketingAudience.delete({ - * // Account ID to which the remarketing audience belongs. - * accountId: 'placeholder-value', - * // The ID of the remarketing audience to delete. - * remarketingAudienceId: 'placeholder-value', - * // Web property ID to which the remarketing audience belongs. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Remarketingaudience$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Remarketingaudience$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Remarketingaudience$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Remarketingaudience$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Remarketingaudience$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'remarketingAudienceId'], - pathParams: ['accountId', 'remarketingAudienceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets a remarketing audience to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.remarketingAudience.get({ - * // The account ID of the remarketing audience to retrieve. - * accountId: 'placeholder-value', - * // The ID of the remarketing audience to retrieve. - * remarketingAudienceId: 'placeholder-value', - * // The web property ID of the remarketing audience to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Remarketingaudience$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Remarketingaudience$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Remarketingaudience$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Remarketingaudience$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Remarketingaudience$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'remarketingAudienceId'], - pathParams: ['accountId', 'remarketingAudienceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a new remarketing audience. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.remarketingAudience.insert({ - * // The account ID for which to create the remarketing audience. - * accountId: 'placeholder-value', - * // Web property ID for which to create the remarketing audience. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Remarketingaudience$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Remarketingaudience$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Remarketingaudience$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Remarketingaudience$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Remarketingaudience$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists remarketing audiences to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.remarketingAudience.list({ - * // The account ID of the remarketing audiences to retrieve. - * accountId: 'placeholder-value', - * // The maximum number of remarketing audiences to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * - * type: 'placeholder-value', - * // The web property ID of the remarketing audiences to retrieve. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Remarketingaudience$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Remarketingaudience$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Remarketingaudience$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Remarketingaudience$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Remarketingaudience$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing remarketing audience. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.remarketingAudience.patch({ - * // The account ID of the remarketing audience to update. - * accountId: 'placeholder-value', - * // The ID of the remarketing audience to update. - * remarketingAudienceId: 'placeholder-value', - * // The web property ID of the remarketing audience to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Remarketingaudience$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Remarketingaudience$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Remarketingaudience$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Remarketingaudience$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Remarketingaudience$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'remarketingAudienceId'], - pathParams: ['accountId', 'remarketingAudienceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing remarketing audience. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.remarketingAudience.update({ - * // The account ID of the remarketing audience to update. - * accountId: 'placeholder-value', - * // The ID of the remarketing audience to update. - * remarketingAudienceId: 'placeholder-value', - * // The web property ID of the remarketing audience to update. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "audienceDefinition": {}, - * // "audienceType": "my_audienceType", - * // "created": "my_created", - * // "description": "my_description", - * // "id": "my_id", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "linkedAdAccounts": [], - * // "linkedViews": [], - * // "name": "my_name", - * // "stateBasedAudienceDefinition": {}, - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Remarketingaudience$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Remarketingaudience$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Remarketingaudience$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Remarketingaudience$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Remarketingaudience$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Remarketingaudience$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Remarketingaudience$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Remarketingaudience$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/remarketingAudiences/{remarketingAudienceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'remarketingAudienceId'], - pathParams: ['accountId', 'remarketingAudienceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Remarketingaudience$Delete extends StandardParameters { - /** - * Account ID to which the remarketing audience belongs. - */ - accountId?: string; - /** - * The ID of the remarketing audience to delete. - */ - remarketingAudienceId?: string; - /** - * Web property ID to which the remarketing audience belongs. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Remarketingaudience$Get extends StandardParameters { - /** - * The account ID of the remarketing audience to retrieve. - */ - accountId?: string; - /** - * The ID of the remarketing audience to retrieve. - */ - remarketingAudienceId?: string; - /** - * The web property ID of the remarketing audience to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Remarketingaudience$Insert extends StandardParameters { - /** - * The account ID for which to create the remarketing audience. - */ - accountId?: string; - /** - * Web property ID for which to create the remarketing audience. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingAudience; - } - export interface Params$Resource$Management$Remarketingaudience$List extends StandardParameters { - /** - * The account ID of the remarketing audiences to retrieve. - */ - accountId?: string; - /** - * The maximum number of remarketing audiences to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * - */ - type?: string; - /** - * The web property ID of the remarketing audiences to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Remarketingaudience$Patch extends StandardParameters { - /** - * The account ID of the remarketing audience to update. - */ - accountId?: string; - /** - * The ID of the remarketing audience to update. - */ - remarketingAudienceId?: string; - /** - * The web property ID of the remarketing audience to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingAudience; - } - export interface Params$Resource$Management$Remarketingaudience$Update extends StandardParameters { - /** - * The account ID of the remarketing audience to update. - */ - accountId?: string; - /** - * The ID of the remarketing audience to update. - */ - remarketingAudienceId?: string; - /** - * The web property ID of the remarketing audience to update. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$RemarketingAudience; - } - - export class Resource$Management$Segments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists segments to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.segments.list({ - * // The maximum number of segments to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Segments$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Segments$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Segments$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Segments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Segments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Segments$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Segments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Segments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v3/management/segments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Segments$List extends StandardParameters { - /** - * The maximum number of segments to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management$Unsampledreports { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes an unsampled report. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.unsampledReports.delete({ - * // Account ID to delete the unsampled report for. - * accountId: 'placeholder-value', - * // View (Profile) ID to delete the unsampled report for. - * profileId: 'placeholder-value', - * // ID of the unsampled report to be deleted. - * unsampledReportId: 'placeholder-value', - * // Web property ID to delete the unsampled reports for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Unsampledreports$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Unsampledreports$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Unsampledreports$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Unsampledreports$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Unsampledreports$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Unsampledreports$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Unsampledreports$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Unsampledreports$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'unsampledReportId', - ], - pathParams: [ - 'accountId', - 'profileId', - 'unsampledReportId', - 'webPropertyId', - ], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns a single unsampled report. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.unsampledReports.get({ - * // Account ID to retrieve unsampled report for. - * accountId: 'placeholder-value', - * // View (Profile) ID to retrieve unsampled report for. - * profileId: 'placeholder-value', - * // ID of the unsampled report to retrieve. - * unsampledReportId: 'placeholder-value', - * // Web property ID to retrieve unsampled reports for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "cloudStorageDownloadDetails": {}, - * // "created": "my_created", - * // "dimensions": "my_dimensions", - * // "downloadType": "my_downloadType", - * // "driveDownloadDetails": {}, - * // "end-date": "my_end-date", - * // "filters": "my_filters", - * // "id": "my_id", - * // "kind": "my_kind", - * // "metrics": "my_metrics", - * // "profileId": "my_profileId", - * // "segment": "my_segment", - * // "selfLink": "my_selfLink", - * // "start-date": "my_start-date", - * // "status": "my_status", - * // "title": "my_title", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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$Management$Unsampledreports$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Unsampledreports$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Unsampledreports$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Unsampledreports$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Unsampledreports$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Unsampledreports$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Unsampledreports$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Unsampledreports$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports/{unsampledReportId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'profileId', - 'unsampledReportId', - ], - pathParams: [ - 'accountId', - 'profileId', - 'unsampledReportId', - 'webPropertyId', - ], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new unsampled report. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.unsampledReports.insert({ - * // Account ID to create the unsampled report for. - * accountId: 'placeholder-value', - * // View (Profile) ID to create the unsampled report for. - * profileId: 'placeholder-value', - * // Web property ID to create the unsampled report for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "cloudStorageDownloadDetails": {}, - * // "created": "my_created", - * // "dimensions": "my_dimensions", - * // "downloadType": "my_downloadType", - * // "driveDownloadDetails": {}, - * // "end-date": "my_end-date", - * // "filters": "my_filters", - * // "id": "my_id", - * // "kind": "my_kind", - * // "metrics": "my_metrics", - * // "profileId": "my_profileId", - * // "segment": "my_segment", - * // "selfLink": "my_selfLink", - * // "start-date": "my_start-date", - * // "status": "my_status", - * // "title": "my_title", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "cloudStorageDownloadDetails": {}, - * // "created": "my_created", - * // "dimensions": "my_dimensions", - * // "downloadType": "my_downloadType", - * // "driveDownloadDetails": {}, - * // "end-date": "my_end-date", - * // "filters": "my_filters", - * // "id": "my_id", - * // "kind": "my_kind", - * // "metrics": "my_metrics", - * // "profileId": "my_profileId", - * // "segment": "my_segment", - * // "selfLink": "my_selfLink", - * // "start-date": "my_start-date", - * // "status": "my_status", - * // "title": "my_title", - * // "updated": "my_updated", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Unsampledreports$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Unsampledreports$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Unsampledreports$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Unsampledreports$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Unsampledreports$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Unsampledreports$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Unsampledreports$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Unsampledreports$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists unsampled reports to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.unsampledReports.list({ - * // Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. - * accountId: 'placeholder-value', - * // The maximum number of unsampled reports to include in this response. - * 'max-results': 'placeholder-value', - * // View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. - * profileId: 'placeholder-value', - * // An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Unsampledreports$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Unsampledreports$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Unsampledreports$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Unsampledreports$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Unsampledreports$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Unsampledreports$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Unsampledreports$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Unsampledreports$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/unsampledReports' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Unsampledreports$Delete extends StandardParameters { - /** - * Account ID to delete the unsampled report for. - */ - accountId?: string; - /** - * View (Profile) ID to delete the unsampled report for. - */ - profileId?: string; - /** - * ID of the unsampled report to be deleted. - */ - unsampledReportId?: string; - /** - * Web property ID to delete the unsampled reports for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Unsampledreports$Get extends StandardParameters { - /** - * Account ID to retrieve unsampled report for. - */ - accountId?: string; - /** - * View (Profile) ID to retrieve unsampled report for. - */ - profileId?: string; - /** - * ID of the unsampled report to retrieve. - */ - unsampledReportId?: string; - /** - * Web property ID to retrieve unsampled reports for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Unsampledreports$Insert extends StandardParameters { - /** - * Account ID to create the unsampled report for. - */ - accountId?: string; - /** - * View (Profile) ID to create the unsampled report for. - */ - profileId?: string; - /** - * Web property ID to create the unsampled report for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UnsampledReport; - } - export interface Params$Resource$Management$Unsampledreports$List extends StandardParameters { - /** - * Account ID to retrieve unsampled reports for. Must be a specific account ID, ~all is not supported. - */ - accountId?: string; - /** - * The maximum number of unsampled reports to include in this response. - */ - 'max-results'?: number; - /** - * View (Profile) ID to retrieve unsampled reports for. Must be a specific view (profile) ID, ~all is not supported. - */ - profileId?: string; - /** - * An index of the first unsampled report to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID to retrieve unsampled reports for. Must be a specific web property ID, ~all is not supported. - */ - webPropertyId?: string; - } - - export class Resource$Management$Uploads { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Delete data associated with a previous upload. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.uploads.deleteUploadData({ - * // Account Id for the uploads to be deleted. - * accountId: '\d+', - * // Custom data source Id for the uploads to be deleted. - * customDataSourceId: '.{22}', - * // Web property Id for the uploads to be deleted. - * webPropertyId: 'UA-(\d+)-(\d+)', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "customDataImportUids": [] - * // } - * }, - * }); - * console.log(res.data); - * } - * - * 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. - */ - deleteUploadData( - params: Params$Resource$Management$Uploads$Deleteuploaddata, - options: StreamMethodOptions - ): Promise>; - deleteUploadData( - params?: Params$Resource$Management$Uploads$Deleteuploaddata, - options?: MethodOptions - ): Promise>; - deleteUploadData( - params: Params$Resource$Management$Uploads$Deleteuploaddata, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteUploadData( - params: Params$Resource$Management$Uploads$Deleteuploaddata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteUploadData( - params: Params$Resource$Management$Uploads$Deleteuploaddata, - callback: BodyResponseCallback - ): void; - deleteUploadData(callback: BodyResponseCallback): void; - deleteUploadData( - paramsOrCallback?: - | Params$Resource$Management$Uploads$Deleteuploaddata - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Uploads$Deleteuploaddata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Uploads$Deleteuploaddata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/deleteUploadData' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customDataSourceId'], - pathParams: ['accountId', 'customDataSourceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * List uploads to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.uploads.get({ - * // Account Id for the upload to retrieve. - * accountId: '\d+', - * // Custom data source Id for upload to retrieve. - * customDataSourceId: '.{22}', - * // Upload Id to retrieve. - * uploadId: '.{22}', - * // Web property Id for the upload to retrieve. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "customDataSourceId": "my_customDataSourceId", - * // "errors": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "status": "my_status", - * // "uploadTime": "my_uploadTime" - * // } - * } - * - * 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$Management$Uploads$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Uploads$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Uploads$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Uploads$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Uploads$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Uploads$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Uploads$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Uploads$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads/{uploadId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'customDataSourceId', - 'uploadId', - ], - pathParams: [ - 'accountId', - 'customDataSourceId', - 'uploadId', - 'webPropertyId', - ], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * List uploads to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.uploads.list({ - * // Account Id for the uploads to retrieve. - * accountId: '\d+', - * // Custom data source Id for uploads to retrieve. - * customDataSourceId: '.{22}', - * // The maximum number of uploads to include in this response. - * 'max-results': 'placeholder-value', - * // A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property Id for the uploads to retrieve. - * webPropertyId: 'UA-(\d+)-(\d+)', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 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. - */ - list( - params: Params$Resource$Management$Uploads$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Uploads$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Uploads$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Uploads$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Uploads$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Uploads$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Uploads$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Uploads$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'customDataSourceId'], - pathParams: ['accountId', 'customDataSourceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Upload data for a custom data source. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * ], - * }); - * - * // 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 analytics.management.uploads.uploadData({ - * // Account Id associated with the upload. - * accountId: '\d+', - * // Custom data source Id to which the data being uploaded belongs. - * customDataSourceId: 'placeholder-value', - * // Web property UA-string associated with the upload. - * webPropertyId: 'UA-\d+-\d+', - * - * requestBody: { - * // request body parameters - * }, - * media: { - * mimeType: 'placeholder-value', - * body: 'placeholder-value', - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "customDataSourceId": "my_customDataSourceId", - * // "errors": [], - * // "id": "my_id", - * // "kind": "my_kind", - * // "status": "my_status", - * // "uploadTime": "my_uploadTime" - * // } - * } - * - * 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. - */ - uploadData( - params: Params$Resource$Management$Uploads$Uploaddata, - options: StreamMethodOptions - ): Promise>; - uploadData( - params?: Params$Resource$Management$Uploads$Uploaddata, - options?: MethodOptions - ): Promise>; - uploadData( - params: Params$Resource$Management$Uploads$Uploaddata, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - uploadData( - params: Params$Resource$Management$Uploads$Uploaddata, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - uploadData( - params: Params$Resource$Management$Uploads$Uploaddata, - callback: BodyResponseCallback - ): void; - uploadData(callback: BodyResponseCallback): void; - uploadData( - paramsOrCallback?: - | Params$Resource$Management$Uploads$Uploaddata - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Uploads$Uploaddata; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Uploads$Uploaddata; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - mediaUrl: ( - rootUrl + - '/upload/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/customDataSources/{customDataSourceId}/uploads' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['accountId', 'webPropertyId', 'customDataSourceId'], - pathParams: ['accountId', 'customDataSourceId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Uploads$Deleteuploaddata extends StandardParameters { - /** - * Account Id for the uploads to be deleted. - */ - accountId?: string; - /** - * Custom data source Id for the uploads to be deleted. - */ - customDataSourceId?: string; - /** - * Web property Id for the uploads to be deleted. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AnalyticsDataimportDeleteUploadDataRequest; - } - export interface Params$Resource$Management$Uploads$Get extends StandardParameters { - /** - * Account Id for the upload to retrieve. - */ - accountId?: string; - /** - * Custom data source Id for upload to retrieve. - */ - customDataSourceId?: string; - /** - * Upload Id to retrieve. - */ - uploadId?: string; - /** - * Web property Id for the upload to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Uploads$List extends StandardParameters { - /** - * Account Id for the uploads to retrieve. - */ - accountId?: string; - /** - * Custom data source Id for uploads to retrieve. - */ - customDataSourceId?: string; - /** - * The maximum number of uploads to include in this response. - */ - 'max-results'?: number; - /** - * A 1-based index of the first upload to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property Id for the uploads to retrieve. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Uploads$Uploaddata extends StandardParameters { - /** - * Account Id associated with the upload. - */ - accountId?: string; - /** - * Custom data source Id to which the data being uploaded belongs. - */ - customDataSourceId?: string; - /** - * Web property UA-string associated with the upload. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: {}; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Management$Webproperties { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a web property to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.webproperties.get({ - * // Account ID to retrieve the web property for. - * accountId: '[0-9]+', - * // ID to retrieve the web property for. - * webPropertyId: 'UA-[0-9]+-[0-9]+', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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$Management$Webproperties$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Webproperties$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Webproperties$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Webproperties$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Webproperties$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webproperties.insert({ - * // Account ID to create the web property for. - * accountId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Webproperties$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Webproperties$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Webproperties$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webproperties$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webproperties$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists web properties to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.webproperties.list({ - * // Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * accountId: 'placeholder-value', - * // The maximum number of web properties to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 0, - * // "username": "my_username" - * // } - * } - * - * 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$Management$Webproperties$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Webproperties$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Webproperties$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webproperties$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webproperties$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing web property. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webproperties.patch({ - * // Account ID to which the web property belongs - * accountId: 'placeholder-value', - * // Web property ID - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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$Management$Webproperties$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Webproperties$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Webproperties$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Webproperties$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Webproperties$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webproperties.update({ - * // Account ID to which the web property belongs - * accountId: 'placeholder-value', - * // Web property ID - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "accountId": "my_accountId", - * // "childLink": {}, - * // "created": "my_created", - * // "dataRetentionResetOnNewActivity": false, - * // "dataRetentionTtl": "my_dataRetentionTtl", - * // "defaultProfileId": "my_defaultProfileId", - * // "id": "my_id", - * // "industryVertical": "my_industryVertical", - * // "internalWebPropertyId": "my_internalWebPropertyId", - * // "kind": "my_kind", - * // "level": "my_level", - * // "name": "my_name", - * // "parentLink": {}, - * // "permissions": {}, - * // "profileCount": 0, - * // "selfLink": "my_selfLink", - * // "starred": false, - * // "updated": "my_updated", - * // "websiteUrl": "my_websiteUrl" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Webproperties$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Webproperties$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Webproperties$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webproperties$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webproperties$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Webproperties$Get extends StandardParameters { - /** - * Account ID to retrieve the web property for. - */ - accountId?: string; - /** - * ID to retrieve the web property for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webproperties$Insert extends StandardParameters { - /** - * Account ID to create the web property for. - */ - accountId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Webproperty; - } - export interface Params$Resource$Management$Webproperties$List extends StandardParameters { - /** - * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - */ - accountId?: string; - /** - * The maximum number of web properties to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - export interface Params$Resource$Management$Webproperties$Patch extends StandardParameters { - /** - * Account ID to which the web property belongs - */ - accountId?: string; - /** - * Web property ID - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Webproperty; - } - export interface Params$Resource$Management$Webproperties$Update extends StandardParameters { - /** - * Account ID to which the web property belongs - */ - accountId?: string; - /** - * Web property ID - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Webproperty; - } - - export class Resource$Management$Webpropertyadwordslinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a web property-Google Ads link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.delete({ - * // ID of the account which the given web property belongs to. - * accountId: 'placeholder-value', - * // Web property Google Ads link ID. - * webPropertyAdWordsLinkId: 'placeholder-value', - * // Web property ID to delete the Google Ads link for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Webpropertyadwordslinks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Webpropertyadwordslinks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Webpropertyadwordslinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Webpropertyadwordslinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Webpropertyadwordslinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Management$Webpropertyadwordslinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'webPropertyAdWordsLinkId', - ], - pathParams: ['accountId', 'webPropertyAdWordsLinkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns a web property-Google Ads link to which the user has access. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.get({ - * // ID of the account which the given web property belongs to. - * accountId: 'placeholder-value', - * // Web property-Google Ads link ID. - * webPropertyAdWordsLinkId: 'placeholder-value', - * // Web property ID to retrieve the Google Ads link for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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$Management$Webpropertyadwordslinks$Get, - options: StreamMethodOptions - ): Promise>; - get( - params?: Params$Resource$Management$Webpropertyadwordslinks$Get, - options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Management$Webpropertyadwordslinks$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Webpropertyadwordslinks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Management$Webpropertyadwordslinks$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyadwordslinks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'webPropertyAdWordsLinkId', - ], - pathParams: ['accountId', 'webPropertyAdWordsLinkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a webProperty-Google Ads link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.insert({ - * // ID of the Google Analytics account to create the link for. - * accountId: 'placeholder-value', - * // Web property ID to create the link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Webpropertyadwordslinks$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Webpropertyadwordslinks$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Webpropertyadwordslinks$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webpropertyadwordslinks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webpropertyadwordslinks$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Management$Webpropertyadwordslinks$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists webProperty-Google Ads links for a given web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.list({ - * // ID of the account which the given web property belongs to. - * accountId: '\d+', - * // The maximum number of webProperty-Google Ads links to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web property ID to retrieve the Google Ads links for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 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. - */ - list( - params: Params$Resource$Management$Webpropertyadwordslinks$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Webpropertyadwordslinks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Webpropertyadwordslinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webpropertyadwordslinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webpropertyadwordslinks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyadwordslinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing webProperty-Google Ads link. This method supports patch semantics. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.patch({ - * // ID of the account which the given web property belongs to. - * accountId: 'placeholder-value', - * // Web property-Google Ads link ID. - * webPropertyAdWordsLinkId: 'placeholder-value', - * // Web property ID to retrieve the Google Ads link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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$Management$Webpropertyadwordslinks$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Management$Webpropertyadwordslinks$Patch, - options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Management$Webpropertyadwordslinks$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Webpropertyadwordslinks$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Management$Webpropertyadwordslinks$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyadwordslinks$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'webPropertyAdWordsLinkId', - ], - pathParams: ['accountId', 'webPropertyAdWordsLinkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an existing webProperty-Google Ads link. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.edit'], - * }); - * - * // 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 analytics.management.webPropertyAdWordsLinks.update({ - * // ID of the account which the given web property belongs to. - * accountId: 'placeholder-value', - * // Web property-Google Ads link ID. - * webPropertyAdWordsLinkId: 'placeholder-value', - * // Web property ID to retrieve the Google Ads link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "adWordsAccounts": [], - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "name": "my_name", - * // "profileIds": [], - * // "selfLink": "my_selfLink" - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Webpropertyadwordslinks$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Webpropertyadwordslinks$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Webpropertyadwordslinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webpropertyadwordslinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webpropertyadwordslinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyadwordslinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyadwordslinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Management$Webpropertyadwordslinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityAdWordsLinks/{webPropertyAdWordsLinkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: [ - 'accountId', - 'webPropertyId', - 'webPropertyAdWordsLinkId', - ], - pathParams: ['accountId', 'webPropertyAdWordsLinkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Webpropertyadwordslinks$Delete extends StandardParameters { - /** - * ID of the account which the given web property belongs to. - */ - accountId?: string; - /** - * Web property Google Ads link ID. - */ - webPropertyAdWordsLinkId?: string; - /** - * Web property ID to delete the Google Ads link for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webpropertyadwordslinks$Get extends StandardParameters { - /** - * ID of the account which the given web property belongs to. - */ - accountId?: string; - /** - * Web property-Google Ads link ID. - */ - webPropertyAdWordsLinkId?: string; - /** - * Web property ID to retrieve the Google Ads link for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webpropertyadwordslinks$Insert extends StandardParameters { - /** - * ID of the Google Analytics account to create the link for. - */ - accountId?: string; - /** - * Web property ID to create the link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityAdWordsLink; - } - export interface Params$Resource$Management$Webpropertyadwordslinks$List extends StandardParameters { - /** - * ID of the account which the given web property belongs to. - */ - accountId?: string; - /** - * The maximum number of webProperty-Google Ads links to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first webProperty-Google Ads link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID to retrieve the Google Ads links for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webpropertyadwordslinks$Patch extends StandardParameters { - /** - * ID of the account which the given web property belongs to. - */ - accountId?: string; - /** - * Web property-Google Ads link ID. - */ - webPropertyAdWordsLinkId?: string; - /** - * Web property ID to retrieve the Google Ads link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityAdWordsLink; - } - export interface Params$Resource$Management$Webpropertyadwordslinks$Update extends StandardParameters { - /** - * ID of the account which the given web property belongs to. - */ - accountId?: string; - /** - * Web property-Google Ads link ID. - */ - webPropertyAdWordsLinkId?: string; - /** - * Web property ID to retrieve the Google Ads link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityAdWordsLink; - } - - export class Resource$Management$Webpropertyuserlinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Removes a user from the given web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.webpropertyUserLinks.delete({ - * // Account ID to delete the user link for. - * accountId: 'placeholder-value', - * // Link ID to delete the user link for. - * linkId: 'placeholder-value', - * // Web Property ID to delete the user link for. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * } - * - * 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$Management$Webpropertyuserlinks$Delete, - options: StreamMethodOptions - ): Promise>; - delete( - params?: Params$Resource$Management$Webpropertyuserlinks$Delete, - options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Management$Webpropertyuserlinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Webpropertyuserlinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Management$Webpropertyuserlinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyuserlinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: BodyResponseCallback | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyuserlinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyuserlinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'linkId'], - pathParams: ['accountId', 'linkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Adds a new user to the given web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.webpropertyUserLinks.insert({ - * // Account ID to create the user link for. - * accountId: 'placeholder-value', - * // Web Property ID to create the user link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - insert( - params: Params$Resource$Management$Webpropertyuserlinks$Insert, - options: StreamMethodOptions - ): Promise>; - insert( - params?: Params$Resource$Management$Webpropertyuserlinks$Insert, - options?: MethodOptions - ): Promise>; - insert( - params: Params$Resource$Management$Webpropertyuserlinks$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webpropertyuserlinks$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Management$Webpropertyuserlinks$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyuserlinks$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyuserlinks$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyuserlinks$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists webProperty-user links for a given web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users', - * 'https://www.googleapis.com/auth/analytics.manage.users.readonly', - * ], - * }); - * - * // 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 analytics.management.webpropertyUserLinks.list({ - * // Account ID which the given web property belongs to. - * accountId: 'placeholder-value', - * // The maximum number of webProperty-user Links to include in this response. - * 'max-results': 'placeholder-value', - * // An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * 'start-index': 'placeholder-value', - * // Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * webPropertyId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "items": [], - * // "itemsPerPage": 0, - * // "kind": "my_kind", - * // "nextLink": "my_nextLink", - * // "previousLink": "my_previousLink", - * // "startIndex": 0, - * // "totalResults": 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. - */ - list( - params: Params$Resource$Management$Webpropertyuserlinks$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Management$Webpropertyuserlinks$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Management$Webpropertyuserlinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webpropertyuserlinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webpropertyuserlinks$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyuserlinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyuserlinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyuserlinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates permissions for an existing user on the given web property. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.manage.users'], - * }); - * - * // 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 analytics.management.webpropertyUserLinks.update({ - * // Account ID to update the account-user link for. - * accountId: 'placeholder-value', - * // Link ID to update the account-user link for. - * linkId: 'placeholder-value', - * // Web property ID to update the account-user link for. - * webPropertyId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "entity": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "permissions": {}, - * // "selfLink": "my_selfLink", - * // "userRef": {} - * // } - * } - * - * 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. - */ - update( - params: Params$Resource$Management$Webpropertyuserlinks$Update, - options: StreamMethodOptions - ): Promise>; - update( - params?: Params$Resource$Management$Webpropertyuserlinks$Update, - options?: MethodOptions - ): Promise>; - update( - params: Params$Resource$Management$Webpropertyuserlinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webpropertyuserlinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Management$Webpropertyuserlinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Management$Webpropertyuserlinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webpropertyuserlinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webpropertyuserlinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v3/management/accounts/{accountId}/webproperties/{webPropertyId}/entityUserLinks/{linkId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'linkId'], - pathParams: ['accountId', 'linkId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Webpropertyuserlinks$Delete extends StandardParameters { - /** - * Account ID to delete the user link for. - */ - accountId?: string; - /** - * Link ID to delete the user link for. - */ - linkId?: string; - /** - * Web Property ID to delete the user link for. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webpropertyuserlinks$Insert extends StandardParameters { - /** - * Account ID to create the user link for. - */ - accountId?: string; - /** - * Web Property ID to create the user link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - export interface Params$Resource$Management$Webpropertyuserlinks$List extends StandardParameters { - /** - * Account ID which the given web property belongs to. - */ - accountId?: string; - /** - * The maximum number of webProperty-user Links to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first webProperty-user link to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web Property ID for the webProperty-user links to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - */ - webPropertyId?: string; - } - export interface Params$Resource$Management$Webpropertyuserlinks$Update extends StandardParameters { - /** - * Account ID to update the account-user link for. - */ - accountId?: string; - /** - * Link ID to update the account-user link for. - */ - linkId?: string; - /** - * Web property ID to update the account-user link for. - */ - webPropertyId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EntityUserLink; - } - - export class Resource$Metadata { - context: APIRequestContext; - columns: Resource$Metadata$Columns; - constructor(context: APIRequestContext) { - this.context = context; - this.columns = new Resource$Metadata$Columns(this.context); - } - } - - export class Resource$Metadata$Columns { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists all columns for a report type - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics', - * 'https://www.googleapis.com/auth/analytics.edit', - * 'https://www.googleapis.com/auth/analytics.readonly', - * ], - * }); - * - * // 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 analytics.metadata.columns.list({ - * // Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API - * reportType: 'ga', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "attributeNames": [], - * // "etag": "my_etag", - * // "items": [], - * // "kind": "my_kind", - * // "totalResults": 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. - */ - list( - params: Params$Resource$Metadata$Columns$List, - options: StreamMethodOptions - ): Promise>; - list( - params?: Params$Resource$Metadata$Columns$List, - options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Metadata$Columns$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Metadata$Columns$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Metadata$Columns$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Metadata$Columns$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Metadata$Columns$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Metadata$Columns$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/metadata/{reportType}/columns' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['reportType'], - pathParams: ['reportType'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Metadata$Columns$List extends StandardParameters { - /** - * Report type. Allowed Values: 'ga'. Where 'ga' corresponds to the Core Reporting API - */ - reportType?: string; - } - - export class Resource$Provisioning { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates an account ticket. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.provision'], - * }); - * - * // 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 analytics.provisioning.createAccountTicket({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "account": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profile": {}, - * // "redirectUri": "my_redirectUri", - * // "webproperty": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "account": {}, - * // "id": "my_id", - * // "kind": "my_kind", - * // "profile": {}, - * // "redirectUri": "my_redirectUri", - * // "webproperty": {} - * // } - * } - * - * 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. - */ - createAccountTicket( - params: Params$Resource$Provisioning$Createaccountticket, - options: StreamMethodOptions - ): Promise>; - createAccountTicket( - params?: Params$Resource$Provisioning$Createaccountticket, - options?: MethodOptions - ): Promise>; - createAccountTicket( - params: Params$Resource$Provisioning$Createaccountticket, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createAccountTicket( - params: Params$Resource$Provisioning$Createaccountticket, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createAccountTicket( - params: Params$Resource$Provisioning$Createaccountticket, - callback: BodyResponseCallback - ): void; - createAccountTicket( - callback: BodyResponseCallback - ): void; - createAccountTicket( - paramsOrCallback?: - | Params$Resource$Provisioning$Createaccountticket - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Provisioning$Createaccountticket; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Provisioning$Createaccountticket; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/provisioning/createAccountTicket' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Provision account. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.provision'], - * }); - * - * // 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 analytics.provisioning.createAccountTree({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "accountName": "my_accountName", - * // "kind": "my_kind", - * // "profileName": "my_profileName", - * // "timezone": "my_timezone", - * // "webpropertyName": "my_webpropertyName", - * // "websiteUrl": "my_websiteUrl" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "account": {}, - * // "kind": "my_kind", - * // "profile": {}, - * // "webproperty": {} - * // } - * } - * - * 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. - */ - createAccountTree( - params: Params$Resource$Provisioning$Createaccounttree, - options: StreamMethodOptions - ): Promise>; - createAccountTree( - params?: Params$Resource$Provisioning$Createaccounttree, - options?: MethodOptions - ): Promise>; - createAccountTree( - params: Params$Resource$Provisioning$Createaccounttree, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createAccountTree( - params: Params$Resource$Provisioning$Createaccounttree, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createAccountTree( - params: Params$Resource$Provisioning$Createaccounttree, - callback: BodyResponseCallback - ): void; - createAccountTree( - callback: BodyResponseCallback - ): void; - createAccountTree( - paramsOrCallback?: - | Params$Resource$Provisioning$Createaccounttree - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Provisioning$Createaccounttree; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Provisioning$Createaccounttree; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/provisioning/createAccountTree' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Provisioning$Createaccountticket extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$AccountTicket; - } - export interface Params$Resource$Provisioning$Createaccounttree extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$AccountTreeRequest; - } - - export class Resource$Userdeletion { - context: APIRequestContext; - userDeletionRequest: Resource$Userdeletion$Userdeletionrequest; - constructor(context: APIRequestContext) { - this.context = context; - this.userDeletionRequest = new Resource$Userdeletion$Userdeletionrequest( - this.context - ); - } - } - - export class Resource$Userdeletion$Userdeletionrequest { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Insert or update a user deletion requests. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/analytics.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 analytics = google.analytics('v3'); - * - * 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/analytics.user.deletion'], - * }); - * - * // 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 analytics.userDeletion.userDeletionRequest.upsert({ - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "deletionRequestTime": "my_deletionRequestTime", - * // "firebaseProjectId": "my_firebaseProjectId", - * // "id": {}, - * // "kind": "my_kind", - * // "propertyId": "my_propertyId", - * // "webPropertyId": "my_webPropertyId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "deletionRequestTime": "my_deletionRequestTime", - * // "firebaseProjectId": "my_firebaseProjectId", - * // "id": {}, - * // "kind": "my_kind", - * // "propertyId": "my_propertyId", - * // "webPropertyId": "my_webPropertyId" - * // } - * } - * - * 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. - */ - upsert( - params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, - options: StreamMethodOptions - ): Promise>; - upsert( - params?: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, - options?: MethodOptions - ): Promise>; - upsert( - params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upsert( - params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upsert( - params: Params$Resource$Userdeletion$Userdeletionrequest$Upsert, - callback: BodyResponseCallback - ): void; - upsert(callback: BodyResponseCallback): void; - upsert( - paramsOrCallback?: - | Params$Resource$Userdeletion$Userdeletionrequest$Upsert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | Promise> - | Promise> { - let params = (paramsOrCallback || - {}) as Params$Resource$Userdeletion$Userdeletionrequest$Upsert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Userdeletion$Userdeletionrequest$Upsert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://analytics.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/analytics/v3/userDeletion/userDeletionRequests:upsert' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Userdeletion$Userdeletionrequest$Upsert extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$UserDeletionRequest; - } -} From 00a842bcff7cb30c307e793add1a5ef6aebe5aaf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 3/7] feat(apikeys): update the API #### apikeys:v2 The following keys were added: - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage.description - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage.enum - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage.enumDescriptions - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage.location - resources.projects.resources.locations.resources.keys.methods.patch.parameters.checkExistingUsage.type --- discovery/apikeys-v2.json | 17 ++++++++++++++++- src/apis/apikeys/v2.ts | 6 ++++++ 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/discovery/apikeys-v2.json b/discovery/apikeys-v2.json index 978838122d2..1e4b53e0e7a 100644 --- a/discovery/apikeys-v2.json +++ b/discovery/apikeys-v2.json @@ -336,6 +336,21 @@ "name" ], "parameters": { + "checkExistingUsage": { + "description": "Optional. Defines the behavior for checking existing usage when updating a key.", + "enum": [ + "CHECK_EXISTING_USAGE_UNSPECIFIED", + "SKIP", + "CHECK" + ], + "enumDescriptions": [ + "When unset, the default behavior is used, which is SKIP.", + "If set, skip checking existing usage when updating a key.", + "If set, existing usage is checked when updating the key. If the key has usage in the last 7 days, the request returns a FAILED_PRECONDITION error." + ], + "location": "query", + "type": "string" + }, "name": { "description": "Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`.", "location": "path", @@ -396,7 +411,7 @@ } } }, - "revision": "20260317", + "revision": "20260721", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/src/apis/apikeys/v2.ts b/src/apis/apikeys/v2.ts index 3ff469a53e4..bfe754e9509 100644 --- a/src/apis/apikeys/v2.ts +++ b/src/apis/apikeys/v2.ts @@ -1434,6 +1434,8 @@ export namespace apikeys_v2 { * * // Do the magic * const res = await apikeys.projects.locations.keys.patch({ + * // Optional. Defines the behavior for checking existing usage when updating a key. + * checkExistingUsage: 'placeholder-value', * // Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. * name: 'projects/my-project/locations/my-location/keys/my-key', * // The field mask specifies which fields to be updated as part of this request. All other fields are ignored. Mutable fields are: `display_name`, `restrictions`, and `annotations`. If an update mask is not provided, the service treats it as an implied mask equivalent to all allowed fields that are set on the wire. If the field mask has a special value "*", the service treats it equivalent to replace all allowed mutable fields. @@ -1763,6 +1765,10 @@ export namespace apikeys_v2 { showDeleted?: boolean; } export interface Params$Resource$Projects$Locations$Keys$Patch extends StandardParameters { + /** + * Optional. Defines the behavior for checking existing usage when updating a key. + */ + checkExistingUsage?: string; /** * Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. */ From 721ea1e3ec81fa88cd43c281b83be4c40fdf01ad Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 4/7] feat(cloudsearch): update the API #### cloudsearch:v1 The following keys were added: - resources.query.resources.sources.methods.list.parameters.requestOptions.countryCode.description - resources.query.resources.sources.methods.list.parameters.requestOptions.countryCode.location - resources.query.resources.sources.methods.list.parameters.requestOptions.countryCode.type - schemas.RequestOptions.properties.countryCode.description - schemas.RequestOptions.properties.countryCode.type --- discovery/cloudsearch-v1.json | 11 ++++++++++- src/apis/cloudsearch/v1.ts | 10 ++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/discovery/cloudsearch-v1.json b/discovery/cloudsearch-v1.json index 8c36a873116..73237c497b2 100644 --- a/discovery/cloudsearch-v1.json +++ b/discovery/cloudsearch-v1.json @@ -1020,6 +1020,11 @@ "location": "query", "type": "string" }, + "requestOptions.countryCode": { + "description": "Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom).", + "location": "query", + "type": "string" + }, "requestOptions.debugOptions.enableDebugging": { "description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.", "location": "query", @@ -2106,7 +2111,7 @@ } } }, - "revision": "20260610", + "revision": "20260729", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "Action": { @@ -6894,6 +6899,10 @@ "description": "The BCP-47 language code, such as \"pt\" or \"en\". It represents the user's preferred Display Language.", "type": "string" }, + "countryCode": { + "description": "Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom).", + "type": "string" + }, "debugOptions": { "$ref": "DebugOptions", "description": "Debug options of the request" diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 747106e9fed..9e57e3c2839 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -2986,6 +2986,10 @@ export namespace cloudsearch_v1 { * The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. */ clientDisplayLanguageCode?: string | null; + /** + * Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). + */ + countryCode?: string | null; /** * Debug options of the request */ @@ -7756,6 +7760,8 @@ export namespace cloudsearch_v1 { * pageToken: 'placeholder-value', * // The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. * 'requestOptions.clientDisplayLanguageCode': 'placeholder-value', + * // Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). + * 'requestOptions.countryCode': 'placeholder-value', * // If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. * 'requestOptions.debugOptions.enableDebugging': 'placeholder-value', * // The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions. @@ -7877,6 +7883,10 @@ export namespace cloudsearch_v1 { * The BCP-47 language code, such as "pt" or "en". It represents the user's preferred Display Language. */ 'requestOptions.clientDisplayLanguageCode'?: string; + /** + * Optional. Specifies the country/region where the query originated, as a lowercase ISO 3166-1 alpha-2 region code (using 'uk' instead of 'gb' for the United Kingdom). + */ + 'requestOptions.countryCode'?: string; /** * If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field. */ From a8a33edcf39a649624c0487f1fb08b4146146ee9 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 5/7] feat(health): update the API #### health:v4 The following keys were added: - schemas.DataPoint.properties.menstrualPeriod.$ref - schemas.DataPoint.properties.menstrualPeriod.description - schemas.DataPoint.properties.moods.$ref - schemas.DataPoint.properties.moods.description - schemas.DataPoint.properties.ovulationTest.$ref - schemas.DataPoint.properties.ovulationTest.description - schemas.DataPoint.properties.symptoms.$ref - schemas.DataPoint.properties.symptoms.description - schemas.MenstrualPeriod.description - schemas.MenstrualPeriod.id - schemas.MenstrualPeriod.properties.interval.$ref - schemas.MenstrualPeriod.properties.interval.description - schemas.MenstrualPeriod.properties.notes.description - schemas.MenstrualPeriod.properties.notes.type - schemas.MenstrualPeriod.type - schemas.Moods.description - schemas.Moods.id - schemas.Moods.properties.moods.description - schemas.Moods.properties.moods.items.enum - schemas.Moods.properties.moods.items.enumDescriptions - schemas.Moods.properties.moods.items.type - schemas.Moods.properties.moods.type - schemas.Moods.properties.sampleTime.$ref - schemas.Moods.properties.sampleTime.description - schemas.Moods.properties.valences.description - schemas.Moods.properties.valences.items.enum - schemas.Moods.properties.valences.items.enumDescriptions - schemas.Moods.properties.valences.items.type - schemas.Moods.properties.valences.type - schemas.Moods.type - schemas.OvulationTest.description - schemas.OvulationTest.id - schemas.OvulationTest.properties.result.description - schemas.OvulationTest.properties.result.enum - schemas.OvulationTest.properties.result.enumDescriptions - schemas.OvulationTest.properties.result.type - schemas.OvulationTest.properties.sampleTime.$ref - schemas.OvulationTest.properties.sampleTime.description - schemas.OvulationTest.type - schemas.Symptoms.description - schemas.Symptoms.id - schemas.Symptoms.properties.sampleTime.$ref - schemas.Symptoms.properties.sampleTime.description - schemas.Symptoms.properties.symptoms.description - schemas.Symptoms.properties.symptoms.items.enum - schemas.Symptoms.properties.symptoms.items.enumDescriptions - schemas.Symptoms.properties.symptoms.items.type - schemas.Symptoms.properties.symptoms.type - schemas.Symptoms.type The following keys were changed: - schemas.Exercise.properties.displayName.description --- discovery/health-v4.json | 303 ++++++++++++++++++++++++++++++++++++++- src/apis/health/v4.ts | 86 ++++++++++- 2 files changed, 386 insertions(+), 3 deletions(-) diff --git a/discovery/health-v4.json b/discovery/health-v4.json index 3985ed43d9d..848396790b3 100644 --- a/discovery/health-v4.json +++ b/discovery/health-v4.json @@ -1078,7 +1078,7 @@ } } }, - "revision": "20260729", + "revision": "20260731", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -2267,6 +2267,14 @@ "$ref": "IrregularRhythmNotification", "description": "Optional. Data for points in the `irregular-rhythm-notification` session data type collection." }, + "menstrualPeriod": { + "$ref": "MenstrualPeriod", + "description": "Optional. Data for points in the `menstrual-period` interval data type collection." + }, + "moods": { + "$ref": "Moods", + "description": "Optional. Data for points in the `moods` sample data type collection." + }, "name": { "description": "Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.", "type": "string" @@ -2275,6 +2283,10 @@ "$ref": "NutritionLog", "description": "Optional. Data for points in the `nutrition-log` session data type collection." }, + "ovulationTest": { + "$ref": "OvulationTest", + "description": "Optional. Data for points in the `ovulation-test` sample data type collection." + }, "oxygenSaturation": { "$ref": "OxygenSaturation", "description": "Optional. Data for points in the `oxygen-saturation` sample data type collection." @@ -2303,6 +2315,10 @@ "$ref": "SwimLengthsData", "description": "Optional. Data for points in the `swim-lengths-data` interval data type collection." }, + "symptoms": { + "$ref": "Symptoms", + "description": "Optional. Data for points in the `symptoms` sample data type collection." + }, "timeInHeartRateZone": { "$ref": "TimeInHeartRateZone", "description": "Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection." @@ -2695,7 +2711,7 @@ "type": "string" }, "displayName": { - "description": "Required. Exercise display name.", + "description": "Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., \"Walking\" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name.", "type": "string" }, "exerciseEvents": { @@ -3908,6 +3924,21 @@ }, "type": "object" }, + "MenstrualPeriod": { + "description": "Menstrual period record.", + "id": "MenstrualPeriod", + "properties": { + "interval": { + "$ref": "ObservationTimeInterval", + "description": "Required. Observed interval." + }, + "notes": { + "description": "Optional. Standard free-form notes captured at manual logging.", + "type": "string" + } + }, + "type": "object" + }, "MetricsSummary": { "description": "Summary metrics for an exercise.", "id": "MetricsSummary", @@ -4005,6 +4036,161 @@ }, "type": "object" }, + "Moods": { + "description": "Moods record.", + "id": "Moods", + "properties": { + "moods": { + "description": "Required. The moods logged.", + "items": { + "enum": [ + "MOOD_UNSPECIFIED", + "AMAZED", + "AMUSED", + "ANGRY", + "ANNOYED", + "ANXIOUS", + "HAPPY", + "CONTENT", + "SAD", + "WORRIED", + "FRUSTRATED", + "EXCITED", + "CALM", + "STRESSED", + "ASHAMED", + "BRAVE", + "CONFIDENT", + "DISAPPOINTED", + "DISCOURAGED", + "DISGUSTED", + "DRAINED", + "EMBARRASSED", + "GRATEFUL", + "GUILTY", + "HOPEFUL", + "HOPELESS", + "INDIFFERENT", + "IRRITATED", + "JEALOUS", + "JOYFUL", + "LONELY", + "OVERWHELMED", + "PASSIONATE", + "PEACEFUL", + "PROUD", + "RELIEVED", + "SATISFIED", + "SCARED", + "SURPRISED", + "ENERGIZED", + "FATIGUED", + "VERY_CALM", + "VERY_STRESSED", + "NEUTRAL", + "AFRAID", + "HURTING", + "BORED", + "BITTER", + "ENVIOUS", + "CONFUSED", + "CURIOUS", + "AWESTRUCK", + "INSPIRED", + "LONGING", + "ACCOMPLISHED", + "LOVING", + "COMPASSIONATE" + ], + "enumDescriptions": [ + "Unspecified mood.", + "Amazed.", + "Amused.", + "Angry.", + "Annoyed.", + "Anxious.", + "Happy.", + "Content.", + "Sad.", + "Worried.", + "Frustrated.", + "Excited.", + "Calm.", + "Stressed.", + "Ashamed.", + "Brave.", + "Confident.", + "Disappointed.", + "Discouraged.", + "Disgusted.", + "Drained.", + "Embarrassed.", + "Grateful.", + "Guilty.", + "Hopeful.", + "Hopeless.", + "Indifferent.", + "Irritated.", + "Jealous.", + "Joyful.", + "Lonely.", + "Overwhelmed.", + "Passionate.", + "Peaceful.", + "Proud.", + "Relieved.", + "Satisfied.", + "Scared.", + "Surprised.", + "Energized.", + "Fatigued.", + "Very calm.", + "Very stressed.", + "Neutral.", + "Afraid.", + "Hurting.", + "Bored.", + "Bitter.", + "Envious.", + "Confused.", + "Curious.", + "Awestruck.", + "Inspired.", + "Longing.", + "Accomplished.", + "Loving.", + "Compassionate." + ], + "type": "string" + }, + "type": "array" + }, + "sampleTime": { + "$ref": "ObservationSampleTime", + "description": "Required. The time at which moods were measured." + }, + "valences": { + "description": "Optional. The valences.", + "items": { + "enum": [ + "VALENCE_UNSPECIFIED", + "UNPLEASANT", + "BASELINE", + "PLEASANT" + ], + "enumDescriptions": [ + "Unspecified valence.", + "Unpleasant.", + "Baseline.", + "Pleasant." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "NutrientQuantity": { "description": "Represents the quantity of a nutrient.", "id": "NutrientQuantity", @@ -4428,6 +4614,37 @@ }, "type": "object" }, + "OvulationTest": { + "description": "Ovulation test record.", + "id": "OvulationTest", + "properties": { + "result": { + "description": "Required. The result of the ovulation test.", + "enum": [ + "OVULATION_TEST_RESULT_UNSPECIFIED", + "NEGATIVE", + "LUTEINIZING_HORMONE_SURGE", + "ESTROGEN_SURGE", + "POSITIVE", + "INDETERMINATE" + ], + "enumDescriptions": [ + "Unspecified result.", + "Negative result.", + "Luteinizing hormone surge.", + "Estrogen surge.", + "Positive result.", + "Indeterminate result." + ], + "type": "string" + }, + "sampleTime": { + "$ref": "ObservationSampleTime", + "description": "Required. The time at which ovulation test was measured." + } + }, + "type": "object" + }, "OxygenSaturation": { "description": "Captures the user's instantaneous oxygen saturation percentage (SpO2).", "id": "OxygenSaturation", @@ -5742,6 +5959,88 @@ }, "type": "object" }, + "Symptoms": { + "description": "Symptoms logged by the user.", + "id": "Symptoms", + "properties": { + "sampleTime": { + "$ref": "ObservationSampleTime", + "description": "Required. Time when the symptoms were logged." + }, + "symptoms": { + "description": "Required. List of symptoms experienced.", + "items": { + "enum": [ + "SYMPTOM_VALUE_UNSPECIFIED", + "CRAMPS", + "HEADACHE", + "TENDER_BREASTS", + "ACNE", + "SICK", + "BLOATED", + "HOT_FLASHES", + "PMS", + "COUGH", + "FEVER", + "DIFFICULTY_BREATHING", + "BACK_PAIN", + "SHAKINESS", + "HUNGER", + "SWEATING", + "ANXIETY", + "THIRST", + "FREQUENT_URINATION", + "BLURRED_VISION", + "OTHER", + "SEX_DRIVE_HIGH", + "SEX_DRIVE_MEDIUM", + "SEX_DRIVE_LOW", + "HEART_PALPITATIONS", + "FAINTING", + "CHEST_PAIN", + "FATIGUE", + "CONFUSION", + "DIZZINESS" + ], + "enumDescriptions": [ + "Unspecified symptom value.", + "Abdominal cramps.", + "Headache.", + "Tender breasts.", + "Acne.", + "Feeling sick or unwell.", + "Bloating or abdominal swelling.", + "Hot flashes.", + "Premenstrual syndrome symptoms.", + "Coughing.", + "Fever or elevated body temperature.", + "Difficulty breathing or shortness of breath.", + "Back pain.", + "Shakiness or tremors.", + "Excessive hunger.", + "Excessive sweating.", + "Anxiety or nervousness.", + "Excessive thirst.", + "Frequent urination.", + "Blurred vision.", + "Other symptoms.", + "High sex drive.", + "Medium sex drive.", + "Low sex drive.", + "Heart palpitations or racing heart.", + "Fainting or loss of consciousness.", + "Chest pain or discomfort.", + "Fatigue or extreme tiredness.", + "Confusion or mental fogginess.", + "Dizziness or lightheadedness." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimeInHeartRateZone": { "description": "Time in heart rate zone record. It's an interval spent in specific heart rate zone.", "id": "TimeInHeartRateZone", diff --git a/src/apis/health/v4.ts b/src/apis/health/v4.ts index 257047987ed..53a55277176 100644 --- a/src/apis/health/v4.ts +++ b/src/apis/health/v4.ts @@ -948,6 +948,14 @@ export namespace health_v4 { * Optional. Data for points in the `irregular-rhythm-notification` session data type collection. */ irregularRhythmNotification?: Schema$IrregularRhythmNotification; + /** + * Optional. Data for points in the `menstrual-period` interval data type collection. + */ + menstrualPeriod?: Schema$MenstrualPeriod; + /** + * Optional. Data for points in the `moods` sample data type collection. + */ + moods?: Schema$Moods; /** * Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user\}/dataTypes/{data_type\}/dataPoints/{data_point\}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user\}` ID is a system-generated identifier, as described in Identity.health_user_id. The `{data_type\}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `heart-rate` for the `heart_rate` field. The `{data_point\}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens. */ @@ -956,6 +964,10 @@ export namespace health_v4 { * Optional. Data for points in the `nutrition-log` session data type collection. */ nutritionLog?: Schema$NutritionLog; + /** + * Optional. Data for points in the `ovulation-test` sample data type collection. + */ + ovulationTest?: Schema$OvulationTest; /** * Optional. Data for points in the `oxygen-saturation` sample data type collection. */ @@ -984,6 +996,10 @@ export namespace health_v4 { * Optional. Data for points in the `swim-lengths-data` interval data type collection. */ swimLengthsData?: Schema$SwimLengthsData; + /** + * Optional. Data for points in the `symptoms` sample data type collection. + */ + symptoms?: Schema$Symptoms; /** * Optional. Data for points in the `time-in-heart-rate-zone` interval data type collection. */ @@ -1208,7 +1224,7 @@ export namespace health_v4 { */ createTime?: string | null; /** - * Required. Exercise display name. + * Required. The localized, human-readable name of the exercise. For all exercise types other than `OTHER`, the system ignores client input and overrides this field with a generated name based on `exercise_type` (e.g., "Walking" for `WALKING`). If `exercise_type` is `OTHER`, this field can contain the user's custom, free-form display name. */ displayName?: string | null; /** @@ -1806,6 +1822,19 @@ export namespace health_v4 { */ serviceVersion?: string | null; } + /** + * Menstrual period record. + */ + export interface Schema$MenstrualPeriod { + /** + * Required. Observed interval. + */ + interval?: Schema$ObservationTimeInterval; + /** + * Optional. Standard free-form notes captured at manual logging. + */ + notes?: string | null; + } /** * Summary metrics for an exercise. */ @@ -1884,6 +1913,23 @@ export namespace health_v4 { */ avgVerticalRatio?: number | null; } + /** + * Moods record. + */ + export interface Schema$Moods { + /** + * Required. The moods logged. + */ + moods?: string[] | null; + /** + * Required. The time at which moods were measured. + */ + sampleTime?: Schema$ObservationSampleTime; + /** + * Optional. The valences. + */ + valences?: string[] | null; + } /** * Represents the quantity of a nutrient. */ @@ -2072,6 +2118,19 @@ export namespace health_v4 { */ startUtcOffset?: string | null; } + /** + * Ovulation test record. + */ + export interface Schema$OvulationTest { + /** + * Required. The result of the ovulation test. + */ + result?: string | null; + /** + * Required. The time at which ovulation test was measured. + */ + sampleTime?: Schema$ObservationSampleTime; + } /** * Captures the user's instantaneous oxygen saturation percentage (SpO2). */ @@ -2968,6 +3027,19 @@ export namespace health_v4 { */ strokeCountSum?: string | null; } + /** + * Symptoms logged by the user. + */ + export interface Schema$Symptoms { + /** + * Required. Time when the symptoms were logged. + */ + sampleTime?: Schema$ObservationSampleTime; + /** + * Required. List of symptoms experienced. + */ + symptoms?: string[] | null; + } /** * Time in heart rate zone record. It's an interval spent in specific heart rate zone. */ @@ -6003,8 +6075,11 @@ export namespace health_v4 { * // "height": {}, * // "hydrationLog": {}, * // "irregularRhythmNotification": {}, + * // "menstrualPeriod": {}, + * // "moods": {}, * // "name": "my_name", * // "nutritionLog": {}, + * // "ovulationTest": {}, * // "oxygenSaturation": {}, * // "respiratoryRateSleepSummary": {}, * // "runVo2Max": {}, @@ -6012,6 +6087,7 @@ export namespace health_v4 { * // "sleep": {}, * // "steps": {}, * // "swimLengthsData": {}, + * // "symptoms": {}, * // "timeInHeartRateZone": {}, * // "vo2Max": {}, * // "weight": {} @@ -6501,8 +6577,11 @@ export namespace health_v4 { * // "height": {}, * // "hydrationLog": {}, * // "irregularRhythmNotification": {}, + * // "menstrualPeriod": {}, + * // "moods": {}, * // "name": "my_name", * // "nutritionLog": {}, + * // "ovulationTest": {}, * // "oxygenSaturation": {}, * // "respiratoryRateSleepSummary": {}, * // "runVo2Max": {}, @@ -6510,6 +6589,7 @@ export namespace health_v4 { * // "sleep": {}, * // "steps": {}, * // "swimLengthsData": {}, + * // "symptoms": {}, * // "timeInHeartRateZone": {}, * // "vo2Max": {}, * // "weight": {} @@ -6832,8 +6912,11 @@ export namespace health_v4 { * // "height": {}, * // "hydrationLog": {}, * // "irregularRhythmNotification": {}, + * // "menstrualPeriod": {}, + * // "moods": {}, * // "name": "my_name", * // "nutritionLog": {}, + * // "ovulationTest": {}, * // "oxygenSaturation": {}, * // "respiratoryRateSleepSummary": {}, * // "runVo2Max": {}, @@ -6841,6 +6924,7 @@ export namespace health_v4 { * // "sleep": {}, * // "steps": {}, * // "swimLengthsData": {}, + * // "symptoms": {}, * // "timeInHeartRateZone": {}, * // "vo2Max": {}, * // "weight": {} From 406322594beacf2289cfab119885441f64e7a656 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 6/7] fix(looker): update the API #### looker:v1 The following keys were changed: - schemas.ListInstancesResponse.properties.instances.description - schemas.ListInstancesResponse.properties.nextPageToken.description --- discovery/looker-v1.json | 6 +++--- src/apis/looker/v1.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 0133cff3987..08cd516e116 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -748,7 +748,7 @@ } } }, - "revision": "20260609", + "revision": "20260726", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1391,14 +1391,14 @@ "id": "ListInstancesResponse", "properties": { "instances": { - "description": "The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize.", + "description": "The list of instances matching the request filters, up to the requested `pageSize`.", "items": { "$ref": "Instance" }, "type": "array" }, "nextPageToken": { - "description": "If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted.", + "description": "If provided, a page token that can look up the next `pageSize` results. If empty, the results list is exhausted.", "type": "string" }, "unreachable": { diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index 93d93cb3338..3c6a5e862be 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -541,11 +541,11 @@ export namespace looker_v1 { */ export interface Schema$ListInstancesResponse { /** - * The list of instances matching the request filters, up to the requested ListInstancesRequest.pageSize. + * The list of instances matching the request filters, up to the requested `pageSize`. */ instances?: Schema$Instance[]; /** - * If provided, a page token that can look up the next ListInstancesRequest.pageSize results. If empty, the results list is exhausted. + * If provided, a page token that can look up the next `pageSize` results. If empty, the results list is exhausted. */ nextPageToken?: string | null; /** From 36908a27e2d53999a285e176d42f487997835358 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Mon, 3 Aug 2026 22:23:39 +0000 Subject: [PATCH 7/7] feat(networkservices): update the API #### networkservices:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.request.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.request.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.scopes - schemas.AgentConnectivityTemplate.description - schemas.AgentConnectivityTemplate.id - schemas.AgentConnectivityTemplate.properties.accessPath.description - schemas.AgentConnectivityTemplate.properties.accessPath.enum - schemas.AgentConnectivityTemplate.properties.accessPath.enumDescriptions - schemas.AgentConnectivityTemplate.properties.accessPath.type - schemas.AgentConnectivityTemplate.properties.accessTypes.description - schemas.AgentConnectivityTemplate.properties.accessTypes.items.enum - schemas.AgentConnectivityTemplate.properties.accessTypes.items.enumDescriptions - schemas.AgentConnectivityTemplate.properties.accessTypes.items.type - schemas.AgentConnectivityTemplate.properties.accessTypes.type - schemas.AgentConnectivityTemplate.properties.createTime.description - schemas.AgentConnectivityTemplate.properties.createTime.format - schemas.AgentConnectivityTemplate.properties.createTime.readOnly - schemas.AgentConnectivityTemplate.properties.createTime.type - schemas.AgentConnectivityTemplate.properties.description.description - schemas.AgentConnectivityTemplate.properties.description.type - schemas.AgentConnectivityTemplate.properties.egressNetworkConfig.$ref - schemas.AgentConnectivityTemplate.properties.egressNetworkConfig.description - schemas.AgentConnectivityTemplate.properties.etag.description - schemas.AgentConnectivityTemplate.properties.etag.type - schemas.AgentConnectivityTemplate.properties.labels.additionalProperties.type - schemas.AgentConnectivityTemplate.properties.labels.description - schemas.AgentConnectivityTemplate.properties.labels.type - schemas.AgentConnectivityTemplate.properties.name.description - schemas.AgentConnectivityTemplate.properties.name.type - schemas.AgentConnectivityTemplate.properties.updateTime.description - schemas.AgentConnectivityTemplate.properties.updateTime.format - schemas.AgentConnectivityTemplate.properties.updateTime.readOnly - schemas.AgentConnectivityTemplate.properties.updateTime.type - schemas.AgentConnectivityTemplate.type - schemas.DnsPeeringConfig.description - schemas.DnsPeeringConfig.id - schemas.DnsPeeringConfig.properties.domain.description - schemas.DnsPeeringConfig.properties.domain.type - schemas.DnsPeeringConfig.properties.targetNetwork.description - schemas.DnsPeeringConfig.properties.targetNetwork.type - schemas.DnsPeeringConfig.type - schemas.EgressNetworkConfig.id - schemas.EgressNetworkConfig.properties.dnsPeeringConfig.$ref - schemas.EgressNetworkConfig.properties.dnsPeeringConfig.description - schemas.EgressNetworkConfig.properties.networkAttachment.description - schemas.EgressNetworkConfig.properties.networkAttachment.type - schemas.EgressNetworkConfig.properties.tlsConfig.$ref - schemas.EgressNetworkConfig.properties.tlsConfig.description - schemas.EgressNetworkConfig.properties.trustConfig.description - schemas.EgressNetworkConfig.properties.trustConfig.type - schemas.EgressNetworkConfig.properties.vpcEgress.description - schemas.EgressNetworkConfig.properties.vpcEgress.enum - schemas.EgressNetworkConfig.properties.vpcEgress.enumDescriptions - schemas.EgressNetworkConfig.properties.vpcEgress.type - schemas.EgressNetworkConfig.type - schemas.EgressNetworkConfigTlsConfig.description - schemas.EgressNetworkConfigTlsConfig.id - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.description - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.enum - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.enumDescriptions - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.type - schemas.EgressNetworkConfigTlsConfig.properties.trustConfig.description - schemas.EgressNetworkConfigTlsConfig.properties.trustConfig.type - schemas.EgressNetworkConfigTlsConfig.type - schemas.ListAgentConnectivityTemplatesResponse.description - schemas.ListAgentConnectivityTemplatesResponse.id - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.description - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.items.$ref - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.type - schemas.ListAgentConnectivityTemplatesResponse.properties.nextPageToken.description - schemas.ListAgentConnectivityTemplatesResponse.properties.nextPageToken.type - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.description - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.items.type - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.type - schemas.ListAgentConnectivityTemplatesResponse.type #### networkservices:v1 The following keys were added: - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.agentConnectivityTemplateId.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.request.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.create.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.etag.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.delete.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.get.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.parameters.returnPartialSuccess.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.list.scopes - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.flatPath - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.httpMethod - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.id - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameterOrder - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.path - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.request.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.response.$ref - resources.projects.resources.locations.resources.agentConnectivityTemplates.methods.patch.scopes - schemas.AgentConnectivityTemplate.description - schemas.AgentConnectivityTemplate.id - schemas.AgentConnectivityTemplate.properties.accessPath.description - schemas.AgentConnectivityTemplate.properties.accessPath.enum - schemas.AgentConnectivityTemplate.properties.accessPath.enumDescriptions - schemas.AgentConnectivityTemplate.properties.accessPath.type - schemas.AgentConnectivityTemplate.properties.accessTypes.description - schemas.AgentConnectivityTemplate.properties.accessTypes.items.enum - schemas.AgentConnectivityTemplate.properties.accessTypes.items.enumDescriptions - schemas.AgentConnectivityTemplate.properties.accessTypes.items.type - schemas.AgentConnectivityTemplate.properties.accessTypes.type - schemas.AgentConnectivityTemplate.properties.createTime.description - schemas.AgentConnectivityTemplate.properties.createTime.format - schemas.AgentConnectivityTemplate.properties.createTime.readOnly - schemas.AgentConnectivityTemplate.properties.createTime.type - schemas.AgentConnectivityTemplate.properties.description.description - schemas.AgentConnectivityTemplate.properties.description.type - schemas.AgentConnectivityTemplate.properties.egressNetworkConfig.$ref - schemas.AgentConnectivityTemplate.properties.egressNetworkConfig.description - schemas.AgentConnectivityTemplate.properties.etag.description - schemas.AgentConnectivityTemplate.properties.etag.type - schemas.AgentConnectivityTemplate.properties.labels.additionalProperties.type - schemas.AgentConnectivityTemplate.properties.labels.description - schemas.AgentConnectivityTemplate.properties.labels.type - schemas.AgentConnectivityTemplate.properties.name.description - schemas.AgentConnectivityTemplate.properties.name.type - schemas.AgentConnectivityTemplate.properties.updateTime.description - schemas.AgentConnectivityTemplate.properties.updateTime.format - schemas.AgentConnectivityTemplate.properties.updateTime.readOnly - schemas.AgentConnectivityTemplate.properties.updateTime.type - schemas.AgentConnectivityTemplate.type - schemas.DnsPeeringConfig.description - schemas.DnsPeeringConfig.id - schemas.DnsPeeringConfig.properties.domain.description - schemas.DnsPeeringConfig.properties.domain.type - schemas.DnsPeeringConfig.properties.targetNetwork.description - schemas.DnsPeeringConfig.properties.targetNetwork.type - schemas.DnsPeeringConfig.type - schemas.EgressNetworkConfig.id - schemas.EgressNetworkConfig.properties.dnsPeeringConfig.$ref - schemas.EgressNetworkConfig.properties.dnsPeeringConfig.description - schemas.EgressNetworkConfig.properties.networkAttachment.description - schemas.EgressNetworkConfig.properties.networkAttachment.type - schemas.EgressNetworkConfig.properties.tlsConfig.$ref - schemas.EgressNetworkConfig.properties.tlsConfig.description - schemas.EgressNetworkConfig.properties.trustConfig.description - schemas.EgressNetworkConfig.properties.trustConfig.type - schemas.EgressNetworkConfig.properties.vpcEgress.description - schemas.EgressNetworkConfig.properties.vpcEgress.enum - schemas.EgressNetworkConfig.properties.vpcEgress.enumDescriptions - schemas.EgressNetworkConfig.properties.vpcEgress.type - schemas.EgressNetworkConfig.type - schemas.EgressNetworkConfigTlsConfig.description - schemas.EgressNetworkConfigTlsConfig.id - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.description - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.enum - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.enumDescriptions - schemas.EgressNetworkConfigTlsConfig.properties.additionalRoots.type - schemas.EgressNetworkConfigTlsConfig.properties.trustConfig.description - schemas.EgressNetworkConfigTlsConfig.properties.trustConfig.type - schemas.EgressNetworkConfigTlsConfig.type - schemas.ListAgentConnectivityTemplatesResponse.description - schemas.ListAgentConnectivityTemplatesResponse.id - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.description - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.items.$ref - schemas.ListAgentConnectivityTemplatesResponse.properties.agentConnectivityTemplates.type - schemas.ListAgentConnectivityTemplatesResponse.properties.nextPageToken.description - schemas.ListAgentConnectivityTemplatesResponse.properties.nextPageToken.type - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.description - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.items.type - schemas.ListAgentConnectivityTemplatesResponse.properties.unreachable.type - schemas.ListAgentConnectivityTemplatesResponse.type --- discovery/networkservices-v1.json | 343 ++++++++- discovery/networkservices-v1beta1.json | 343 ++++++++- src/apis/networkservices/v1.ts | 948 +++++++++++++++++++++++++ src/apis/networkservices/v1beta1.ts | 946 ++++++++++++++++++++++++ 4 files changed, 2578 insertions(+), 2 deletions(-) diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index a07b110b974..7ea64e61552 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -183,6 +183,173 @@ } }, "resources": { + "agentConnectivityTemplates": { + "methods": { + "create": { + "description": "Creates a new AgentConnectivityTemplate in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", + "httpMethod": "POST", + "id": "networkservices.projects.locations.agentConnectivityTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "agentConnectivityTemplateId": { + "description": "Required. Short name of the AgentConnectivityTemplate resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/agentConnectivityTemplates", + "request": { + "$ref": "AgentConnectivityTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single AgentConnectivityTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.agentConnectivityTemplates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the AgentConnectivityTemplate to delete.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single AgentConnectivityTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.agentConnectivityTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "AgentConnectivityTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AgentConnectivityTemplates in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", + "httpMethod": "GET", + "id": "networkservices.projects.locations.agentConnectivityTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of AgentConnectivityTemplates to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/agentConnectivityTemplates", + "response": { + "$ref": "ListAgentConnectivityTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single AgentConnectivityTemplate.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.agentConnectivityTemplates.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "AgentConnectivityTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "agentGateways": { "methods": { "create": { @@ -3732,9 +3899,82 @@ } } }, - "revision": "20260710", + "revision": "20260724", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { + "AgentConnectivityTemplate": { + "description": "AgentConnectivityTemplate represents a reusable network configuration.", + "id": "AgentConnectivityTemplate", + "properties": { + "accessPath": { + "description": "Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.", + "enum": [ + "ACCESS_PATH_UNSPECIFIED", + "CLIENT_TO_AGENT", + "AGENT_TO_ANYWHERE" + ], + "enumDescriptions": [ + "Unspecified access path.", + "Protect connection to Agent or Tool.", + "Govern agent connections to destinations." + ], + "type": "string" + }, + "accessTypes": { + "description": "Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.", + "items": { + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "PUBLIC", + "PRIVATE" + ], + "enumDescriptions": [ + "Unspecified access type.", + "Public network access.", + "Private network access." + ], + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A free-text description of the resource. Max length 1024 characters.", + "type": "string" + }, + "egressNetworkConfig": { + "$ref": "EgressNetworkConfig", + "description": "Optional. Configuration for egress network traffic." + }, + "etag": { + "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of label tags associated with the AgentConnectivityTemplate resource.", + "type": "object" + }, + "name": { + "description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AgentGateway": { "description": "AgentGateway represents the agent gateway resource.", "id": "AgentGateway", @@ -4102,6 +4342,82 @@ "properties": {}, "type": "object" }, + "DnsPeeringConfig": { + "description": "DNS Peering configuration.", + "id": "DnsPeeringConfig", + "properties": { + "domain": { + "description": "Optional. The domain to peer.", + "type": "string" + }, + "targetNetwork": { + "description": "Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}", + "type": "string" + } + }, + "type": "object" + }, + "EgressNetworkConfig": { + "id": "EgressNetworkConfig", + "properties": { + "dnsPeeringConfig": { + "$ref": "DnsPeeringConfig", + "description": "Optional. DNS Peering configuration." + }, + "networkAttachment": { + "description": "Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}", + "type": "string" + }, + "tlsConfig": { + "$ref": "EgressNetworkConfigTlsConfig", + "description": "Optional. The TLS configuration for the egress traffic." + }, + "trustConfig": { + "description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", + "type": "string" + }, + "vpcEgress": { + "description": "Optional. The VPC egress setting.", + "enum": [ + "VPC_EGRESS_UNSPECIFIED", + "ALL_TRAFFIC", + "PRIVATE_RANGES_ONLY" + ], + "enumDescriptions": [ + "Unspecified", + "All outbound traffic is routed through the VPC connector.", + "Only private IP ranges are routed through the VPC connector." + ], + "type": "string" + } + }, + "type": "object" + }, + "EgressNetworkConfigTlsConfig": { + "description": "Configuration for TLS connections.", + "id": "EgressNetworkConfigTlsConfig", + "properties": { + "additionalRoots": { + "description": "Optional. The additional roots to trust.", + "enum": [ + "ADDITIONAL_ROOTS_UNSPECIFIED", + "NO_ADDITIONAL_ROOTS", + "PUBLICLY_TRUSTED_ROOTS" + ], + "enumDescriptions": [ + "Unspecified additional roots.", + "Trust only the certificates provided in `trust_config`.", + "Trust certificates provided in `trust_config` and publicly trusted roots." + ], + "type": "string" + }, + "trustConfig": { + "description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -5629,6 +5945,31 @@ }, "type": "object" }, + "ListAgentConnectivityTemplatesResponse": { + "description": "Response returned by the ListAgentConnectivityTemplates method.", + "id": "ListAgentConnectivityTemplatesResponse", + "properties": { + "agentConnectivityTemplates": { + "description": "List of AgentConnectivityTemplate resources.", + "items": { + "$ref": "AgentConnectivityTemplate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListAgentGatewaysResponse": { "description": "Response returned by the ListAgentGateways method.", "id": "ListAgentGatewaysResponse", diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 62822a709d3..341daa3517a 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -183,6 +183,173 @@ } }, "resources": { + "agentConnectivityTemplates": { + "methods": { + "create": { + "description": "Creates a new AgentConnectivityTemplate in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", + "httpMethod": "POST", + "id": "networkservices.projects.locations.agentConnectivityTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "agentConnectivityTemplateId": { + "description": "Required. Short name of the AgentConnectivityTemplate resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/agentConnectivityTemplates", + "request": { + "$ref": "AgentConnectivityTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single AgentConnectivityTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.agentConnectivityTemplates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. The etag of the AgentConnectivityTemplate to delete.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single AgentConnectivityTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.agentConnectivityTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/*/locations/*/agentConnectivityTemplates/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "AgentConnectivityTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AgentConnectivityTemplates in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates", + "httpMethod": "GET", + "id": "networkservices.projects.locations.agentConnectivityTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Maximum number of AgentConnectivityTemplates to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+parent}/agentConnectivityTemplates", + "response": { + "$ref": "ListAgentConnectivityTemplatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single AgentConnectivityTemplate.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agentConnectivityTemplates/{agentConnectivityTemplatesId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.agentConnectivityTemplates.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agentConnectivityTemplates/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "AgentConnectivityTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "agentGateways": { "methods": { "create": { @@ -3277,9 +3444,82 @@ } } }, - "revision": "20260710", + "revision": "20260724", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { + "AgentConnectivityTemplate": { + "description": "AgentConnectivityTemplate represents a reusable network configuration.", + "id": "AgentConnectivityTemplate", + "properties": { + "accessPath": { + "description": "Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set.", + "enum": [ + "ACCESS_PATH_UNSPECIFIED", + "CLIENT_TO_AGENT", + "AGENT_TO_ANYWHERE" + ], + "enumDescriptions": [ + "Unspecified access path.", + "Protect connection to Agent or Tool.", + "Govern agent connections to destinations." + ], + "type": "string" + }, + "accessTypes": { + "description": "Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured.", + "items": { + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "PUBLIC", + "PRIVATE" + ], + "enumDescriptions": [ + "Unspecified access type.", + "Public network access.", + "Private network access." + ], + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A free-text description of the resource. Max length 1024 characters.", + "type": "string" + }, + "egressNetworkConfig": { + "$ref": "EgressNetworkConfig", + "description": "Optional. Configuration for egress network traffic." + }, + "etag": { + "description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of label tags associated with the AgentConnectivityTemplate resource.", + "type": "object" + }, + "name": { + "description": "Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/*/locations/*/agentConnectivityTemplates/`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "AgentGateway": { "description": "AgentGateway represents the agent gateway resource.", "id": "AgentGateway", @@ -3577,6 +3817,82 @@ "properties": {}, "type": "object" }, + "DnsPeeringConfig": { + "description": "DNS Peering configuration.", + "id": "DnsPeeringConfig", + "properties": { + "domain": { + "description": "Optional. The domain to peer.", + "type": "string" + }, + "targetNetwork": { + "description": "Optional. The target network resource name for DNS peering. Format: projects/{project}/global/networks/{network_id}", + "type": "string" + } + }, + "type": "object" + }, + "EgressNetworkConfig": { + "id": "EgressNetworkConfig", + "properties": { + "dnsPeeringConfig": { + "$ref": "DnsPeeringConfig", + "description": "Optional. DNS Peering configuration." + }, + "networkAttachment": { + "description": "Optional. The network attachment resource name. Format: projects/{project}/regions/{region}/networkAttachments/{network_attachment_id}", + "type": "string" + }, + "tlsConfig": { + "$ref": "EgressNetworkConfigTlsConfig", + "description": "Optional. The TLS configuration for the egress traffic." + }, + "trustConfig": { + "description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", + "type": "string" + }, + "vpcEgress": { + "description": "Optional. The VPC egress setting.", + "enum": [ + "VPC_EGRESS_UNSPECIFIED", + "ALL_TRAFFIC", + "PRIVATE_RANGES_ONLY" + ], + "enumDescriptions": [ + "Unspecified", + "All outbound traffic is routed through the VPC connector.", + "Only private IP ranges are routed through the VPC connector." + ], + "type": "string" + } + }, + "type": "object" + }, + "EgressNetworkConfigTlsConfig": { + "description": "Configuration for TLS connections.", + "id": "EgressNetworkConfigTlsConfig", + "properties": { + "additionalRoots": { + "description": "Optional. The additional roots to trust.", + "enum": [ + "ADDITIONAL_ROOTS_UNSPECIFIED", + "NO_ADDITIONAL_ROOTS", + "PUBLICLY_TRUSTED_ROOTS" + ], + "enumDescriptions": [ + "Unspecified additional roots.", + "Trust only the certificates provided in `trust_config`.", + "Trust certificates provided in `trust_config` and publicly trusted roots." + ], + "type": "string" + }, + "trustConfig": { + "description": "Optional. The trust config resource name. Format: projects/{project}/locations/{location}/trustConfigs/{trust_config}", + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -5108,6 +5424,31 @@ }, "type": "object" }, + "ListAgentConnectivityTemplatesResponse": { + "description": "Response returned by the ListAgentConnectivityTemplates method.", + "id": "ListAgentConnectivityTemplatesResponse", + "properties": { + "agentConnectivityTemplates": { + "description": "List of AgentConnectivityTemplate resources.", + "items": { + "$ref": "AgentConnectivityTemplate" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`.", + "type": "string" + }, + "unreachable": { + "description": "Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListAgentGatewaysResponse": { "description": "Response returned by the ListAgentGateways method.", "id": "ListAgentGatewaysResponse", diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 01616353025..655e54ef02e 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -124,6 +124,47 @@ export namespace networkservices_v1 { } } + /** + * AgentConnectivityTemplate represents a reusable network configuration. + */ + export interface Schema$AgentConnectivityTemplate { + /** + * Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set. + */ + accessPath?: string | null; + /** + * Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured. + */ + accessTypes?: string[] | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A free-text description of the resource. Max length 1024 characters. + */ + description?: string | null; + /** + * Optional. Configuration for egress network traffic. + */ + egressNetworkConfig?: Schema$EgressNetworkConfig; + /** + * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + */ + etag?: string | null; + /** + * Optional. Set of label tags associated with the AgentConnectivityTemplate resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } /** * AgentGateway represents the agent gateway resource. */ @@ -363,6 +404,54 @@ export namespace networkservices_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * DNS Peering configuration. + */ + export interface Schema$DnsPeeringConfig { + /** + * Optional. The domain to peer. + */ + domain?: string | null; + /** + * Optional. The target network resource name for DNS peering. Format: projects/{project\}/global/networks/{network_id\} + */ + targetNetwork?: string | null; + } + export interface Schema$EgressNetworkConfig { + /** + * Optional. DNS Peering configuration. + */ + dnsPeeringConfig?: Schema$DnsPeeringConfig; + /** + * Optional. The network attachment resource name. Format: projects/{project\}/regions/{region\}/networkAttachments/{network_attachment_id\} + */ + networkAttachment?: string | null; + /** + * Optional. The TLS configuration for the egress traffic. + */ + tlsConfig?: Schema$EgressNetworkConfigTlsConfig; + /** + * Optional. The trust config resource name. Format: projects/{project\}/locations/{location\}/trustConfigs/{trust_config\} + */ + trustConfig?: string | null; + /** + * Optional. The VPC egress setting. + */ + vpcEgress?: string | null; + } + /** + * Configuration for TLS connections. + */ + export interface Schema$EgressNetworkConfigTlsConfig { + /** + * Optional. The additional roots to trust. + */ + additionalRoots?: string | null; + /** + * Optional. The trust config resource name. Format: projects/{project\}/locations/{location\}/trustConfigs/{trust_config\} + */ + trustConfig?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -1423,6 +1512,23 @@ export namespace networkservices_v1 { */ updateTime?: string | null; } + /** + * Response returned by the ListAgentConnectivityTemplates method. + */ + export interface Schema$ListAgentConnectivityTemplatesResponse { + /** + * List of AgentConnectivityTemplate resources. + */ + agentConnectivityTemplates?: Schema$AgentConnectivityTemplate[]; + /** + * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListAgentGateways method. */ @@ -2615,6 +2721,7 @@ export namespace networkservices_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + agentConnectivityTemplates: Resource$Projects$Locations$Agentconnectivitytemplates; agentGateways: Resource$Projects$Locations$Agentgateways; authzExtensions: Resource$Projects$Locations$Authzextensions; edgeCacheKeysets: Resource$Projects$Locations$Edgecachekeysets; @@ -2638,6 +2745,10 @@ export namespace networkservices_v1 { wasmPlugins: Resource$Projects$Locations$Wasmplugins; constructor(context: APIRequestContext) { this.context = context; + this.agentConnectivityTemplates = + new Resource$Projects$Locations$Agentconnectivitytemplates( + this.context + ); this.agentGateways = new Resource$Projects$Locations$Agentgateways( this.context ); @@ -3009,6 +3120,843 @@ export namespace networkservices_v1 { pageToken?: string; } + export class Resource$Projects$Locations$Agentconnectivitytemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new AgentConnectivityTemplate in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('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 networkservices.projects.locations.agentConnectivityTemplates.create({ + * // Required. Short name of the AgentConnectivityTemplate resource to be created. + * agentConnectivityTemplateId: 'placeholder-value', + * // Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/agentConnectivityTemplates').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 a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('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 networkservices.projects.locations.agentConnectivityTemplates.delete({ + * // Optional. The etag of the AgentConnectivityTemplate to delete. + * etag: 'placeholder-value', + * // Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * }); + * 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$Agentconnectivitytemplates$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 details of a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('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 networkservices.projects.locations.agentConnectivityTemplates.get({ + * // Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "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$Agentconnectivitytemplates$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.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 AgentConnectivityTemplates in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('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 networkservices.projects.locations.agentConnectivityTemplates.list({ + * // Optional. Maximum number of AgentConnectivityTemplates to return per call. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * // Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "agentConnectivityTemplates": [], + * // "nextPageToken": "my_nextPageToken", + * // "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$Agentconnectivitytemplates$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/agentConnectivityTemplates').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 the parameters of a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('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 networkservices.projects.locations.agentConnectivityTemplates.patch({ + * // Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * // Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.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); + } + } + } + + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create extends StandardParameters { + /** + * Required. Short name of the AgentConnectivityTemplate resource to be created. + */ + agentConnectivityTemplateId?: string; + /** + * Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AgentConnectivityTemplate; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete extends StandardParameters { + /** + * Optional. The etag of the AgentConnectivityTemplate to delete. + */ + etag?: string; + /** + * Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get extends StandardParameters { + /** + * Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$List extends StandardParameters { + /** + * Optional. Maximum number of AgentConnectivityTemplates to return per call. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/x/locations/x`. + */ + parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch extends StandardParameters { + /** + * Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AgentConnectivityTemplate; + } + export class Resource$Projects$Locations$Agentgateways { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index a360055ba3b..545b0b45830 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -124,6 +124,47 @@ export namespace networkservices_v1beta1 { } } + /** + * AgentConnectivityTemplate represents a reusable network configuration. + */ + export interface Schema$AgentConnectivityTemplate { + /** + * Required. Immutable. The path of the access. Maps roughly to ingress/egress, though we keep CLIENT_TO_AGENT and AGENT_TO_ANYWHERE as carryovers from Agent Gateway's original resource model. The path is immutable once set. Exactly one path can be set. + */ + accessPath?: string | null; + /** + * Optional. The types of network access provided to the gateway. Both PUBLIC and PRIVATE can be configured. + */ + accessTypes?: string[] | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A free-text description of the resource. Max length 1024 characters. + */ + description?: string | null; + /** + * Optional. Configuration for egress network traffic. + */ + egressNetworkConfig?: Schema$EgressNetworkConfig; + /** + * Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + */ + etag?: string | null; + /** + * Optional. Set of label tags associated with the AgentConnectivityTemplate resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } /** * AgentGateway represents the agent gateway resource. */ @@ -320,6 +361,54 @@ export namespace networkservices_v1beta1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * DNS Peering configuration. + */ + export interface Schema$DnsPeeringConfig { + /** + * Optional. The domain to peer. + */ + domain?: string | null; + /** + * Optional. The target network resource name for DNS peering. Format: projects/{project\}/global/networks/{network_id\} + */ + targetNetwork?: string | null; + } + export interface Schema$EgressNetworkConfig { + /** + * Optional. DNS Peering configuration. + */ + dnsPeeringConfig?: Schema$DnsPeeringConfig; + /** + * Optional. The network attachment resource name. Format: projects/{project\}/regions/{region\}/networkAttachments/{network_attachment_id\} + */ + networkAttachment?: string | null; + /** + * Optional. The TLS configuration for the egress traffic. + */ + tlsConfig?: Schema$EgressNetworkConfigTlsConfig; + /** + * Optional. The trust config resource name. Format: projects/{project\}/locations/{location\}/trustConfigs/{trust_config\} + */ + trustConfig?: string | null; + /** + * Optional. The VPC egress setting. + */ + vpcEgress?: string | null; + } + /** + * Configuration for TLS connections. + */ + export interface Schema$EgressNetworkConfigTlsConfig { + /** + * Optional. The additional roots to trust. + */ + additionalRoots?: string | null; + /** + * Optional. The trust config resource name. Format: projects/{project\}/locations/{location\}/trustConfigs/{trust_config\} + */ + trustConfig?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -1378,6 +1467,23 @@ export namespace networkservices_v1beta1 { */ updateTime?: string | null; } + /** + * Response returned by the ListAgentConnectivityTemplates method. + */ + export interface Schema$ListAgentConnectivityTemplatesResponse { + /** + * List of AgentConnectivityTemplate resources. + */ + agentConnectivityTemplates?: Schema$AgentConnectivityTemplate[]; + /** + * If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. + */ + nextPageToken?: string | null; + /** + * Unordered list. Unreachable resources. Populated when the request attempts to list all resources across all supported locations, while some locations are temporarily unavailable. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListAgentGateways method. */ @@ -2415,6 +2521,7 @@ export namespace networkservices_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; + agentConnectivityTemplates: Resource$Projects$Locations$Agentconnectivitytemplates; agentGateways: Resource$Projects$Locations$Agentgateways; authzExtensions: Resource$Projects$Locations$Authzextensions; endpointPolicies: Resource$Projects$Locations$Endpointpolicies; @@ -2434,6 +2541,10 @@ export namespace networkservices_v1beta1 { wasmPlugins: Resource$Projects$Locations$Wasmplugins; constructor(context: APIRequestContext) { this.context = context; + this.agentConnectivityTemplates = + new Resource$Projects$Locations$Agentconnectivitytemplates( + this.context + ); this.agentGateways = new Resource$Projects$Locations$Agentgateways( this.context ); @@ -2792,6 +2903,841 @@ export namespace networkservices_v1beta1 { pageToken?: string; } + export class Resource$Projects$Locations$Agentconnectivitytemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new AgentConnectivityTemplate in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.agentConnectivityTemplates.create({ + * // Required. Short name of the AgentConnectivityTemplate resource to be created. + * agentConnectivityTemplateId: 'placeholder-value', + * // Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: StreamMethodOptions + ): Promise>; + create( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options?: MethodOptions + ): Promise>; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/agentConnectivityTemplates' + ).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 a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.agentConnectivityTemplates.delete({ + * // Optional. The etag of the AgentConnectivityTemplate to delete. + * etag: 'placeholder-value', + * // Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * }); + * 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$Agentconnectivitytemplates$Delete, + options: StreamMethodOptions + ): Promise>; + delete( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options?: MethodOptions + ): Promise>; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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 details of a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.agentConnectivityTemplates.get({ + * // Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "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$Agentconnectivitytemplates$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + options: + MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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 AgentConnectivityTemplates in a given project and location. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.agentConnectivityTemplates.list({ + * // Optional. Maximum number of AgentConnectivityTemplates to return per call. + * pageSize: 'placeholder-value', + * // Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data. + * pageToken: 'placeholder-value', + * // Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/x/locations/x`. + * parent: 'projects/my-project/locations/my-location', + * // Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + * returnPartialSuccess: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "agentConnectivityTemplates": [], + * // "nextPageToken": "my_nextPageToken", + * // "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$Agentconnectivitytemplates$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options?: MethodOptions + ): Promise< + GaxiosResponseWithHTTP2 + >; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise< + GaxiosResponseWithHTTP2 + > + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/agentConnectivityTemplates' + ).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 the parameters of a single AgentConnectivityTemplate. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/networkservices.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 networkservices = google.networkservices('v1beta1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = + * await networkservices.projects.locations.agentConnectivityTemplates.patch({ + * // Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + * name: 'projects/my-project/locations/my-location/agentConnectivityTemplates/my-agentConnectivityTemplate', + * // Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "accessPath": "my_accessPath", + * // "accessTypes": [], + * // "createTime": "my_createTime", + * // "description": "my_description", + * // "egressNetworkConfig": {}, + * // "etag": "my_etag", + * // "labels": {}, + * // "name": "my_name", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: StreamMethodOptions + ): Promise>; + patch( + params?: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options?: MethodOptions + ): Promise>; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + BodyResponseCallback | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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$Agentconnectivitytemplates$Create extends StandardParameters { + /** + * Required. Short name of the AgentConnectivityTemplate resource to be created. + */ + agentConnectivityTemplateId?: string; + /** + * Required. The parent resource of the AgentConnectivityTemplate. Must be in the format `projects/x/locations/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AgentConnectivityTemplate; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Delete extends StandardParameters { + /** + * Optional. The etag of the AgentConnectivityTemplate to delete. + */ + etag?: string; + /** + * Required. A name of the AgentConnectivityTemplate to delete. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Get extends StandardParameters { + /** + * Required. A name of the AgentConnectivityTemplate to get. Must be in the format `projects/x/locations/x/agentConnectivityTemplates/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$List extends StandardParameters { + /** + * Optional. Maximum number of AgentConnectivityTemplates to return per call. + */ + pageSize?: number; + /** + * Optional. The value returned by the last `ListAgentConnectivityTemplatesResponse` Indicates that this is a continuation of a prior `ListAgentConnectivityTemplates` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the AgentConnectivityTemplates should be listed, specified in the format `projects/x/locations/x`. + */ + parent?: string; + /** + * Optional. If true, allow partial responses for multi-regional Aggregated List requests. Otherwise if one of the locations is down or unreachable, the Aggregated List request will fail. + */ + returnPartialSuccess?: boolean; + } + export interface Params$Resource$Projects$Locations$Agentconnectivitytemplates$Patch extends StandardParameters { + /** + * Identifier. Name of the AgentConnectivityTemplate resource. It matches pattern `projects/x/locations/x/agentConnectivityTemplates/`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the AgentConnectivityTemplate resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AgentConnectivityTemplate; + } + export class Resource$Projects$Locations$Agentgateways { context: APIRequestContext; constructor(context: APIRequestContext) {